ZoneSearchIf (KonaKart Server Engine API Documentation)

All Known Implementing Classes:

ZoneSearch
```
public interface ZoneSearchIf
```
Contains information required to search for a zone. Whenever an attribute is set, it is used as a constraint. When using the java API, a com.konakart.app.ZoneSearch object is normally instantiated. Note that when this object initializes it sets the following attributes:
- id = com.konakart.bl.ConstantsMgr.NOT_SET
- countryId = com.konakart.bl.ConstantsMgr.NOT_SET
When using the SOAP interface directly (not through the KonaKart SOAP engine), this initialisation will not be done (because you will most probably be initializing an object created by a tool such as Apache Axis by reading the WSDL), so you will have to do it manually.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCode()` The code of the zone
`int`	`getCodeRule()` The rule for the search.
`int`	`getCountryId()` The numeric id of the country
`java.lang.String`	`getCustom1()` Custom1 field
`int`	`getCustom1Rule()` The rule for the search.
`java.lang.String`	`getCustom2()` Custom2 field
`int`	`getCustom2Rule()` The rule for the search.
`java.lang.String`	`getCustom3()` Custom3 field
`int`	`getCustom3Rule()` The rule for the search.
`int`	`getId()` The numeric id of the zone
`java.lang.Boolean`	`getInvisible()` Used as a constraint if not null.
`java.lang.String`	`getName()` The name of the zone
`int`	`getNameRule()` The rule for the search.
`java.lang.String`	`getSearchString()` Used to add a constraint to the zoneSearch attribute of the zone.
`int`	`getSearchStringRule()` The rule for the search.
`void`	`setCode(java.lang.String code)` The code of the zone
`void`	`setCodeRule(int codeRule)` The rule for the search.
`void`	`setCountryId(int countryId)` The numeric id of the country
`void`	`setCustom1(java.lang.String custom1)` Custom1 field
`void`	`setCustom1Rule(int custom1Rule)` The rule for the search.
`void`	`setCustom2(java.lang.String custom2)` Custom2 field
`void`	`setCustom2Rule(int custom2Rule)` The rule for the search.
`void`	`setCustom3(java.lang.String custom3)` Custom3 field
`void`	`setCustom3Rule(int custom3Rule)` The rule for the search.
`void`	`setId(int id)` The numeric id of the zone
`void`	`setInvisible(java.lang.Boolean invisible)` Used as a constraint if not null.
`void`	`setName(java.lang.String name)` The name of the zone
`void`	`setNameRule(int nameRule)` The rule for the search.
`void`	`setSearchString(java.lang.String searchString)` Used to add a constraint to the zoneSearch attribute of the zone.
`void`	`setSearchStringRule(int searchStringRule)` The rule for the search.

- Method Detail
  - getSearchString
```
java.lang.String getSearchString()
```
    Used to add a constraint to the zoneSearch attribute of the zone. When inserting the zone, this attribute can be given any value. For example, if a way of identifying a zone is through a combination of zip code and country name, then this attribute may contain the zip code concatenated with the county name so that it can be easily searched for using data contained within the customer's address.
    
    Returns:
    
    the searchString
  - setSearchString
```
void setSearchString(java.lang.String searchString)
```
    Used to add a constraint to the zoneSearch attribute of the zone. When inserting the zone, this attribute can be given any value. For example, if a way of identifying a zone is through a combination of zip code and country name, then this attribute may contain the zip code concatenated with the county name so that it can be easily searched for using data contained within the customer's address.
    
    Parameters:
    
    searchString - the searchString to set
  - getSearchStringRule
```
int getSearchStringRule()
```
    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 searchStringRule
  - setSearchStringRule
```
void setSearchStringRule(int searchStringRule)
```
    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:
    
    searchStringRule - the searchStringRule to set
  - getId
```
int getId()
```
    The numeric id of the zone
    
    Returns:
    
    the id
  - setId
```
void setId(int id)
```
    The numeric id of the zone
    
    Parameters:
    
    id - the id to set
  - getCountryId
```
int getCountryId()
```
    The numeric id of the country
    
    Returns:
    
    the countryId
  - setCountryId
```
void setCountryId(int countryId)
```
    The numeric id of the country
    
    Parameters:
    
    countryId - the countryId to set
  - getCode
```
java.lang.String getCode()
```
    The code of the zone
    
    Returns:
    
    the code
  - setCode
```
void setCode(java.lang.String code)
```
    The code of the zone
    
    Parameters:
    
    code - the code to set
  - getCodeRule
```
int getCodeRule()
```
    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 codeRule
  - setCodeRule
```
void setCodeRule(int codeRule)
```
    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:
    
    codeRule - the codeRule to set
  - getName
```
java.lang.String getName()
```
    The name of the zone
    
    Returns:
    
    the name
  - setName
```
void setName(java.lang.String name)
```
    The name of the zone
    
    Parameters:
    
    name - the name to set
  - getNameRule
```
int getNameRule()
```
    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 nameRule
  - setNameRule
```
void setNameRule(int nameRule)
```
    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:
    
    nameRule - the nameRule to set
  - getInvisible
```
java.lang.Boolean getInvisible()
```
    Used as a constraint if not null.
    
    Returns:
    
    the invisible
  - setInvisible
```
void setInvisible(java.lang.Boolean invisible)
```
    Used as a constraint if not null.
    
    Parameters:
    
    invisible - the invisible to set
  - getCustom1
```
java.lang.String getCustom1()
```
    Custom1 field
    
    Returns:
    
    the custom1
  - setCustom1
```
void setCustom1(java.lang.String custom1)
```
    Custom1 field
    
    Parameters:
    
    custom1 - the custom1 to set
  - getCustom1Rule
```
int getCustom1Rule()
```
    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 custom1Rule
  - setCustom1Rule
```
void setCustom1Rule(int custom1Rule)
```
    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:
    
    custom1Rule - the custom1Rule to set
  - getCustom2
```
java.lang.String getCustom2()
```
    Custom2 field
    
    Returns:
    
    the custom2
  - setCustom2
```
void setCustom2(java.lang.String custom2)
```
    Custom2 field
    
    Parameters:
    
    custom2 - the custom2 to set
  - getCustom2Rule
```
int getCustom2Rule()
```
    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 custom2Rule
  - setCustom2Rule
```
void setCustom2Rule(int custom2Rule)
```
    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:
    
    custom2Rule - the custom2Rule to set
  - getCustom3
```
java.lang.String getCustom3()
```
    Custom3 field
    
    Returns:
    
    the custom3
  - setCustom3
```
void setCustom3(java.lang.String custom3)
```
    Custom3 field
    
    Parameters:
    
    custom3 - the custom3 to set
  - getCustom3Rule
```
int getCustom3Rule()
```
    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 custom3Rule
  - setCustom3Rule
```
void setCustom3Rule(int custom3Rule)
```
    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:
    
    custom3Rule - the custom3Rule to set

Interface ZoneSearchIf

Method Summary

Method Detail

getSearchString

setSearchString

getSearchStringRule

setSearchStringRule

getId

setId

getCountryId

setCountryId

getCode

setCode

getCodeRule

setCodeRule

getName

setName

getNameRule

setNameRule

getInvisible

setInvisible

getCustom1

setCustom1

getCustom1Rule

setCustom1Rule

getCustom2

setCustom2

getCustom2Rule

setCustom2Rule

getCustom3

setCustom3

getCustom3Rule

setCustom3Rule