ZoneSearch (KonaKart Server Engine API Documentation)

java.lang.Object
- com.konakart.app.ZoneSearch

All Implemented Interfaces:

ZoneSearchIf
```
public class ZoneSearch
extends java.lang.Object
implements 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.

Constructor Summary

Constructors
Constructor and Description

ZoneSearch()
Constructor

Constructors
Constructor and Description
`ZoneSearch()` Constructor

Method Summary

All Methods Instance Methods Concrete 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ZoneSearch
```
public ZoneSearch()
```
    Constructor
- Method Detail
  - getSearchString
```
public java.lang.String getSearchString()
```
    Description copied from interface: ZoneSearchIf
    
    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.
    
    Specified by:
    
    getSearchString in interface ZoneSearchIf
    
    Returns:
    
    the searchString
  - setSearchString
```
public void setSearchString(java.lang.String searchString)
```
    Description copied from interface: ZoneSearchIf
    
    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.
    
    Specified by:
    
    setSearchString in interface ZoneSearchIf
    
    Parameters:
    
    searchString - the searchString to set
  - getSearchStringRule
```
public int getSearchStringRule()
```
    Description copied from interface: ZoneSearchIf
    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
    Specified by:
    
    getSearchStringRule in interface ZoneSearchIf
    
    Returns:
    
    the searchStringRule
  - setSearchStringRule
```
public void setSearchStringRule(int searchStringRule)
```
    Description copied from interface: ZoneSearchIf
    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
    Specified by:
    
    setSearchStringRule in interface ZoneSearchIf
    
    Parameters:
    
    searchStringRule - the searchStringRule to set
  - getId
```
public int getId()
```
    Description copied from interface: ZoneSearchIf
    
    The numeric id of the zone
    
    Specified by:
    
    getId in interface ZoneSearchIf
    
    Returns:
    
    the id
  - setId
```
public void setId(int id)
```
    Description copied from interface: ZoneSearchIf
    
    The numeric id of the zone
    
    Specified by:
    
    setId in interface ZoneSearchIf
    
    Parameters:
    
    id - the id to set
  - getCountryId
```
public int getCountryId()
```
    Description copied from interface: ZoneSearchIf
    
    The numeric id of the country
    
    Specified by:
    
    getCountryId in interface ZoneSearchIf
    
    Returns:
    
    the countryId
  - setCountryId
```
public void setCountryId(int countryId)
```
    Description copied from interface: ZoneSearchIf
    
    The numeric id of the country
    
    Specified by:
    
    setCountryId in interface ZoneSearchIf
    
    Parameters:
    
    countryId - the countryId to set
  - getCode
```
public java.lang.String getCode()
```
    Description copied from interface: ZoneSearchIf
    
    The code of the zone
    
    Specified by:
    
    getCode in interface ZoneSearchIf
    
    Returns:
    
    the code
  - setCode
```
public void setCode(java.lang.String code)
```
    Description copied from interface: ZoneSearchIf
    
    The code of the zone
    
    Specified by:
    
    setCode in interface ZoneSearchIf
    
    Parameters:
    
    code - the code to set
  - getCodeRule
```
public int getCodeRule()
```
    Description copied from interface: ZoneSearchIf
    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
    Specified by:
    
    getCodeRule in interface ZoneSearchIf
    
    Returns:
    
    the codeRule
  - setCodeRule
```
public void setCodeRule(int codeRule)
```
    Description copied from interface: ZoneSearchIf
    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
    Specified by:
    
    setCodeRule in interface ZoneSearchIf
    
    Parameters:
    
    codeRule - the codeRule to set
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: ZoneSearchIf
    
    The name of the zone
    
    Specified by:
    
    getName in interface ZoneSearchIf
    
    Returns:
    
    the name
  - setName
```
public void setName(java.lang.String name)
```
    Description copied from interface: ZoneSearchIf
    
    The name of the zone
    
    Specified by:
    
    setName in interface ZoneSearchIf
    
    Parameters:
    
    name - the name to set
  - getNameRule
```
public int getNameRule()
```
    Description copied from interface: ZoneSearchIf
    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
    Specified by:
    
    getNameRule in interface ZoneSearchIf
    
    Returns:
    
    the nameRule
  - setNameRule
```
public void setNameRule(int nameRule)
```
    Description copied from interface: ZoneSearchIf
    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
    Specified by:
    
    setNameRule in interface ZoneSearchIf
    
    Parameters:
    
    nameRule - the nameRule to set
  - getInvisible
```
public java.lang.Boolean getInvisible()
```
    Description copied from interface: ZoneSearchIf
    
    Used as a constraint if not null.
    
    Specified by:
    
    getInvisible in interface ZoneSearchIf
    
    Returns:
    
    the invisible
  - setInvisible
```
public void setInvisible(java.lang.Boolean invisible)
```
    Description copied from interface: ZoneSearchIf
    
    Used as a constraint if not null.
    
    Specified by:
    
    setInvisible in interface ZoneSearchIf
    
    Parameters:
    
    invisible - the invisible to set
  - getCustom1
```
public java.lang.String getCustom1()
```
    Description copied from interface: ZoneSearchIf
    
    Custom1 field
    
    Specified by:
    
    getCustom1 in interface ZoneSearchIf
    
    Returns:
    
    the custom1
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Description copied from interface: ZoneSearchIf
    
    Custom1 field
    
    Specified by:
    
    setCustom1 in interface ZoneSearchIf
    
    Parameters:
    
    custom1 - the custom1 to set
  - getCustom1Rule
```
public int getCustom1Rule()
```
    Description copied from interface: ZoneSearchIf
    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
    Specified by:
    
    getCustom1Rule in interface ZoneSearchIf
    
    Returns:
    
    the custom1Rule
  - setCustom1Rule
```
public void setCustom1Rule(int custom1Rule)
```
    Description copied from interface: ZoneSearchIf
    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
    Specified by:
    
    setCustom1Rule in interface ZoneSearchIf
    
    Parameters:
    
    custom1Rule - the custom1Rule to set
  - getCustom2
```
public java.lang.String getCustom2()
```
    Description copied from interface: ZoneSearchIf
    
    Custom2 field
    
    Specified by:
    
    getCustom2 in interface ZoneSearchIf
    
    Returns:
    
    the custom2
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Description copied from interface: ZoneSearchIf
    
    Custom2 field
    
    Specified by:
    
    setCustom2 in interface ZoneSearchIf
    
    Parameters:
    
    custom2 - the custom2 to set
  - getCustom2Rule
```
public int getCustom2Rule()
```
    Description copied from interface: ZoneSearchIf
    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
    Specified by:
    
    getCustom2Rule in interface ZoneSearchIf
    
    Returns:
    
    the custom2Rule
  - setCustom2Rule
```
public void setCustom2Rule(int custom2Rule)
```
    Description copied from interface: ZoneSearchIf
    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
    Specified by:
    
    setCustom2Rule in interface ZoneSearchIf
    
    Parameters:
    
    custom2Rule - the custom2Rule to set
  - getCustom3
```
public java.lang.String getCustom3()
```
    Description copied from interface: ZoneSearchIf
    
    Custom3 field
    
    Specified by:
    
    getCustom3 in interface ZoneSearchIf
    
    Returns:
    
    the custom3
  - setCustom3
```
public void setCustom3(java.lang.String custom3)
```
    Description copied from interface: ZoneSearchIf
    
    Custom3 field
    
    Specified by:
    
    setCustom3 in interface ZoneSearchIf
    
    Parameters:
    
    custom3 - the custom3 to set
  - getCustom3Rule
```
public int getCustom3Rule()
```
    Description copied from interface: ZoneSearchIf
    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
    Specified by:
    
    getCustom3Rule in interface ZoneSearchIf
    
    Returns:
    
    the custom3Rule
  - setCustom3Rule
```
public void setCustom3Rule(int custom3Rule)
```
    Description copied from interface: ZoneSearchIf
    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
    Specified by:
    
    setCustom3Rule in interface ZoneSearchIf
    
    Parameters:
    
    custom3Rule - the custom3Rule to set

Class ZoneSearch

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ZoneSearch

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