com.konakart.appif
Interface CustomerSearchIf

All Known Implementing Classes:

CustomerSearch

public interface CustomerSearchIf

Contains information required to search for a customer. Whenever an attribute is set, it is used as a constraint. When using the java API, a com.konakart.app.CustomerSearch object is normally instantiated. Note that when this object initialises it sets the following attributes:

• id = com.konakart.bl.ConstantsMgr.NOT_SET
• groupId = com.konakart.bl.ConstantsMgr.NOT_SET
• type = com.konakart.bl.ConstantsMgr.NOT_SET

When using the SOAP interface, this initialisation will not be done (because you will most probably be initialising an object created by a tool such as Apache Axis by reading the WSDL), so you will have to do it manually.

Method Summary

java.util.Calendar	getBirthDate()
java.lang.String	getCity()
java.lang.String	getCityOrState() Searches in the city and state
int	getCityRule() The rule for the search.
java.lang.String	getEmailAddr()
int	getEmailAddrRule() The rule for the search.
java.util.Calendar	getEventDate() Used for searching for customer lists for events such as weddings or birthdays
java.lang.String	getFirstName()
java.lang.String	getFirstName1() Used when searching for a second person which may be present in for example, a wedding list.
int	getFirstName1Rule() The rule for the search.
int	getFirstNameRule() The rule for the search.
int	getId()
java.lang.String	getLastName()
java.lang.String	getLastName1() Used when searching for a second person which may be present in for example, a wedding list.
int	getLastName1Rule() The rule for the search.
int	getLastNameRule() The rule for the search.
java.lang.String	getState()
int	getStateRule() The rule for the search.
int	getTmpId() Used when searching for objects such as Wish Lists that belong to temporary customers.
int	getType()
void	setBirthDate(java.util.Calendar birthDate)
void	setCity(java.lang.String city)
void	setCityOrState(java.lang.String cityOrState) Searches in the city and state
void	setCityRule(int cityRule) The rule for the search.
void	setEmailAddr(java.lang.String emailAddr)
void	setEmailAddrRule(int emailAddrRule) The rule for the search.
void	setEventDate(java.util.Calendar eventDate) Used for searching for customer lists for events such as weddings or birthdays
void	setFirstName(java.lang.String firstName)
void	setFirstName1(java.lang.String firstName1) Used when searching for a second person which may be present in for example, a wedding list.
void	setFirstName1Rule(int firstName1Rule) The rule for the search.
void	setFirstNameRule(int firstNameRule) The rule for the search.
void	setId(int id)
void	setLastName(java.lang.String lastName)
void	setLastName1(java.lang.String lastName1) Used when searching for a second person which may be present in for example, a wedding list.
void	setLastName1Rule(int lastName1Rule) The rule for the search.
void	setLastNameRule(int lastNameRule) The rule for the search.
void	setState(java.lang.String state)
void	setStateRule(int stateRule) The rule for the search.
void	setTmpId(int tmpId) Used when searching for objects such as Wish Lists that belong to temporary customers.
void	setType(int type)

Method Detail

getEmailAddr

java.lang.String getEmailAddr()

Returns:

Returns the emailAddr.

setEmailAddr

void setEmailAddr(java.lang.String emailAddr)

Parameters:

emailAddr - The emailAddr to set.

getFirstName

java.lang.String getFirstName()

Returns:

Returns the firstName.

setFirstName

void setFirstName(java.lang.String firstName)

Parameters:

firstName - The firstName to set.

getId

int getId()

Returns:

Returns the id.

setId

void setId(int id)

Parameters:

id - The id to set.

getLastName

java.lang.String getLastName()

Returns:

Returns the lastName.

setLastName

void setLastName(java.lang.String lastName)

Parameters:

lastName - The lastName to set.

getBirthDate

java.util.Calendar getBirthDate()

Returns:

Returns the birthDate.

setBirthDate

void setBirthDate(java.util.Calendar birthDate)

Parameters:

birthDate - The birthDate to set.

getType

int getType()

Returns:

Returns the type.

setType

void setType(int type)

Parameters:

type - The type to set.

getCity

java.lang.String getCity()

Returns:

Returns the city.

setCity

void setCity(java.lang.String city)

Parameters:

city - The city to set.

getState

java.lang.String getState()

Returns:

Returns the state.

setState

void setState(java.lang.String state)

Parameters:

state - The state to set.

getCityOrState

java.lang.String getCityOrState()

Searches in the city and state

Returns:

Returns the cityOrState.

setCityOrState

void setCityOrState(java.lang.String cityOrState)

Searches in the city and state

Parameters:

cityOrState - The cityOrState to set.

getFirstName1

java.lang.String getFirstName1()

Used when searching for a second person which may be present in for example, a wedding list.

Returns:

the firstName1

setFirstName1

void setFirstName1(java.lang.String firstName1)

Used when searching for a second person which may be present in for example, a wedding list.

Parameters:

firstName1 - the firstName1 to set

getLastName1

java.lang.String getLastName1()

Used when searching for a second person which may be present in for example, a wedding list.

Returns:

the lastName1

setLastName1

void setLastName1(java.lang.String lastName1)

Used when searching for a second person which may be present in for example, a wedding list.

Parameters:

lastName1 - the lastName1 to set

getEventDate

java.util.Calendar getEventDate()

Used for searching for customer lists for events such as weddings or birthdays

Returns:

the eventDate

setEventDate

void setEventDate(java.util.Calendar eventDate)

Used for searching for customer lists for events such as weddings or birthdays

Parameters:

eventDate - the eventDate to set

getFirstNameRule

int getFirstNameRule()

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER

Returns:

the firstNameRule

setFirstNameRule

void setFirstNameRule(int firstNameRule)

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER

Parameters:

firstNameRule - the firstNameRule to set

getLastNameRule

int getLastNameRule()

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER

Returns:

the lastNameRule

setLastNameRule

void setLastNameRule(int lastNameRule)

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER

Parameters:

lastNameRule - the lastNameRule to set

getFirstName1Rule

int getFirstName1Rule()

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER

Returns:

the firstName1Rule

setFirstName1Rule

void setFirstName1Rule(int firstName1Rule)

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER

Parameters:

firstName1Rule - the firstName1Rule to set

getLastName1Rule

int getLastName1Rule()

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER

Returns:

the lastName1Rule

setLastName1Rule

void setLastName1Rule(int lastName1Rule)

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER

Parameters:

lastName1Rule - the lastName1Rule to set

getEmailAddrRule

int getEmailAddrRule()

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER

Returns:

the emailAddrRule

setEmailAddrRule

void setEmailAddrRule(int emailAddrRule)

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER

Parameters:

emailAddrRule - the emailAddrRule to set

getCityRule

int getCityRule()

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER

Returns:

the cityRule

setCityRule

void setCityRule(int cityRule)

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER

Parameters:

cityRule - the cityRule to set

getStateRule

int getStateRule()

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER

Returns:

the stateRule

setStateRule

void setStateRule(int stateRule)

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER

Parameters:

stateRule - the stateRule to set

getTmpId

int getTmpId()

Used when searching for objects such as Wish Lists that belong to temporary customers. In order for this id to be used, it must be set to a negative value. Otherwise it will not be used as a constraint.

Returns:

the tmpId

setTmpId

void setTmpId(int tmpId)

Used when searching for objects such as Wish Lists that belong to temporary customers. In order for this id to be used, it must be set to a negative value. Otherwise it will not be used as a constraint.

Parameters:

tmpId - the tmpId to set