AdminAddressSearch (KonaKartAdmin API Documentation)

java.lang.Object
- com.konakartadmin.app.AdminAddressSearch

public class AdminAddressSearch
extends java.lang.Object

AdminAddressSearch object for the Admin App

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`addrStoreId` addrStoreId
`private java.lang.String`	`city` city
`private int`	`cityRule` city Rule
`private java.lang.String`	`companyName` company Name
`private int`	`companyNameRule` company Name Rule
`private int`	`countryId` country Id
`private java.lang.String`	`custom1` custom1
`private int`	`custom1Rule` custom1 Rule
`private java.lang.String`	`custom2` custom2
`private int`	`custom2Rule` custom2 Rule
`private java.lang.String`	`custom3` custom3
`private int`	`custom3Rule` custom3 Rule
`private java.lang.String`	`custom4` custom4
`private int`	`custom4Rule` custom4 Rule
`private java.lang.String`	`custom5` custom5
`private int`	`custom5Rule` custom5 Rule
`private int`	`customerId` customer Id
`private java.lang.String`	`firstName` first name
`private int`	`firstNameRule` first Name Rule
`private boolean`	`formatAddresses` When set, the formattedAddress attribute of the Address objects is populated.
`private int`	`id` Address id
`private java.lang.String`	`lastName` last name
`private int`	`lastNameRule` last Name Rule
`private int`	`manufacturerId` manufacturer Id
`private java.lang.String`	`orderBy` orderBy - Specify one of these to order the results: AdminSearch.ORDER_BY_LASTNAME_ASCENDING AdminSearch.ORDER_BY_LASTNAME_DESCENDING AdminSearch.ORDER_BY_ID_ASCENDING (the default) AdminSearch.ORDER_BY_ID_DESCENDING
`private java.lang.String`	`postcode` postcode
`private int`	`postcodeRule` postcode Rule
`private int`	`productId` product Id
`private java.lang.String`	`state` state
`private int`	`stateRule` state Rule
`private java.lang.String`	`storeId` store Id
`private java.lang.String`	`streetAddress` street Address
`private java.lang.String`	`streetAddress1` street Address1
`private int`	`streetAddress1Rule` street Address1 Rule
`private int`	`streetAddressRule` street Address Rule
`private java.lang.String`	`suburb` suburb
`private int`	`suburbRule` suburb Rule
`private int`	`type` Address type
`private boolean`	`useDefaultWildCards` Deprecated. Use attribute rules instead
`private int`	`vendorId` vendor Id
`private int`	`zoneId` zone Id

Constructor Summary

Constructors
Constructor and Description
`AdminAddressSearch()` Instantiates an AdminAddressSearch object - a requirement for a bean class
`AdminAddressSearch(com.workingdogs.village.Record r, com.konakart.db.KKCriteria c)` Instantiates the attributes of the AdminAddressSearch object from a Record object

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAddrStoreId()` Set with a valid storeId when searching for addresses for that store
`java.lang.String`	`getCity()`
`int`	`getCityRule()` The rule for the search.
`java.lang.String`	`getCompanyName()`
`int`	`getCompanyNameRule()` The rule for the search.
`int`	`getCountryId()`
`java.lang.String`	`getCustom1()`
`int`	`getCustom1Rule()` The rule for the search.
`java.lang.String`	`getCustom2()`
`int`	`getCustom2Rule()` The rule for the search.
`java.lang.String`	`getCustom3()`
`int`	`getCustom3Rule()` The rule for the search.
`java.lang.String`	`getCustom4()`
`int`	`getCustom4Rule()` The rule for the search.
`java.lang.String`	`getCustom5()`
`int`	`getCustom5Rule()` The rule for the search.
`int`	`getCustomerId()`
`java.lang.String`	`getFirstName()`
`int`	`getFirstNameRule()` The rule for the search.
`int`	`getId()`
`java.lang.String`	`getLastName()`
`int`	`getLastNameRule()` The rule for the search.
`int`	`getManufacturerId()`
`java.lang.String`	`getOrderBy()`
`java.lang.String`	`getPostcode()`
`int`	`getPostcodeRule()` The rule for the search.
`int`	`getProductId()`
`java.lang.String`	`getState()`
`int`	`getStateRule()` The rule for the search.
`java.lang.String`	`getStoreId()` Used to search for addresses associated with a store
`java.lang.String`	`getStreetAddress()`
`java.lang.String`	`getStreetAddress1()`
`int`	`getStreetAddress1Rule()` The rule for the search.
`int`	`getStreetAddressRule()` The rule for the search.
`java.lang.String`	`getSuburb()`
`int`	`getSuburbRule()` The rule for the search.
`int`	`getType()` It can take the following values: com.konakartadmin.bl.KonakartAdminConstants.ADDRESS_TYPE_CUSTOMER = A customer address com.konakartadmin.bl.KonakartAdminConstants.ADDRESS_TYPE_PRODUCT = Address related to a product.
`int`	`getVendorId()`
`int`	`getZoneId()`
`boolean`	`isFormatAddresses()` When set, the formattedAddress attribute of the Address objects is populated.
`boolean`	`isUseDefaultWildCards()` Deprecated. Use attribute rules instead
`void`	`setAddrStoreId(java.lang.String addrStoreId)` Set with a valid storeId when searching for addresses for that store
`void`	`setCity(java.lang.String city)`
`void`	`setCityRule(int cityRule)` The rule for the search.
`void`	`setCompanyName(java.lang.String companyName)`
`void`	`setCompanyNameRule(int companyNameRule)` The rule for the search.
`void`	`setCountryId(int countryId)`
`void`	`setCustom1(java.lang.String custom1)`
`void`	`setCustom1Rule(int custom1Rule)` The rule for the search.
`void`	`setCustom2(java.lang.String custom2)`
`void`	`setCustom2Rule(int custom2Rule)` The rule for the search.
`void`	`setCustom3(java.lang.String custom3)`
`void`	`setCustom3Rule(int custom3Rule)` The rule for the search.
`void`	`setCustom4(java.lang.String custom4)`
`void`	`setCustom4Rule(int custom4Rule)` The rule for the search.
`void`	`setCustom5(java.lang.String custom5)`
`void`	`setCustom5Rule(int custom5Rule)` The rule for the search.
`void`	`setCustomerId(int customerId)`
`void`	`setFirstName(java.lang.String firstName)`
`void`	`setFirstNameRule(int firstNameRule)` The rule for the search.
`void`	`setFormatAddresses(boolean formatAddresses)` When set, the formattedAddress attribute of the Address objects is populated.
`void`	`setId(int id)`
`void`	`setLastName(java.lang.String lastName)`
`void`	`setLastNameRule(int lastNameRule)` The rule for the search.
`void`	`setManufacturerId(int manufacturerId)`
`void`	`setOrderBy(java.lang.String orderBy)`
`void`	`setPostcode(java.lang.String postcode)`
`void`	`setPostcodeRule(int postcodeRule)` The rule for the search.
`void`	`setProductId(int productId)`
`void`	`setState(java.lang.String state)`
`void`	`setStateRule(int stateRule)` The rule for the search.
`void`	`setStoreId(java.lang.String storeId)` Used to search for addresses associated with a store
`void`	`setStreetAddress(java.lang.String streetAddress)`
`void`	`setStreetAddress1(java.lang.String streetAddress1)`
`void`	`setStreetAddress1Rule(int streetAddress1Rule)` The rule for the search.
`void`	`setStreetAddressRule(int streetAddressRule)` The rule for the search.
`void`	`setSuburb(java.lang.String suburb)`
`void`	`setSuburbRule(int suburbRule)` The rule for the search.
`void`	`setType(int type)` It can take the following values: com.konakartadmin.bl.KonakartAdminConstants.ADDRESS_TYPE_CUSTOMER = A customer address com.konakartadmin.bl.KonakartAdminConstants.ADDRESS_TYPE_PRODUCT = Address related to a product.
`void`	`setUseDefaultWildCards(boolean useDefaultWildCards)` Deprecated. Use attribute rules instead
`void`	`setVendorId(int vendorId)`
`void`	`setZoneId(int zoneId)`
`java.lang.String`	`toString()`
`java.lang.String`	`toStringBrief()`

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

- Field Detail
  - id
```
private int id
```
    Address id
  - type
```
private int type
```
    Address type
  - countryId
```
private int countryId
```
    country Id
  - zoneId
```
private int zoneId
```
    zone Id
  - customerId
```
private int customerId
```
    customer Id
  - productId
```
private int productId
```
    product Id
  - manufacturerId
```
private int manufacturerId
```
    manufacturer Id
  - vendorId
```
private int vendorId
```
    vendor Id
  - storeId
```
private java.lang.String storeId
```
    store Id
  - lastName
```
private java.lang.String lastName
```
    last name
  - lastNameRule
```
private int lastNameRule
```
    last Name Rule
  - firstName
```
private java.lang.String firstName
```
    first name
  - firstNameRule
```
private int firstNameRule
```
    first Name Rule
  - streetAddress
```
private java.lang.String streetAddress
```
    street Address
  - streetAddressRule
```
private int streetAddressRule
```
    street Address Rule
  - streetAddress1
```
private java.lang.String streetAddress1
```
    street Address1
  - streetAddress1Rule
```
private int streetAddress1Rule
```
    street Address1 Rule
  - companyName
```
private java.lang.String companyName
```
    company Name
  - companyNameRule
```
private int companyNameRule
```
    company Name Rule
  - suburb
```
private java.lang.String suburb
```
    suburb
  - suburbRule
```
private int suburbRule
```
    suburb Rule
  - postcode
```
private java.lang.String postcode
```
    postcode
  - postcodeRule
```
private int postcodeRule
```
    postcode Rule
  - city
```
private java.lang.String city
```
    city
  - cityRule
```
private int cityRule
```
    city Rule
  - state
```
private java.lang.String state
```
    state
  - stateRule
```
private int stateRule
```
    state Rule
  - custom1
```
private java.lang.String custom1
```
    custom1
  - custom2
```
private java.lang.String custom2
```
    custom2
  - custom3
```
private java.lang.String custom3
```
    custom3
  - custom4
```
private java.lang.String custom4
```
    custom4
  - custom5
```
private java.lang.String custom5
```
    custom5
  - custom1Rule
```
private int custom1Rule
```
    custom1 Rule
  - custom2Rule
```
private int custom2Rule
```
    custom2 Rule
  - custom3Rule
```
private int custom3Rule
```
    custom3 Rule
  - custom4Rule
```
private int custom4Rule
```
    custom4 Rule
  - custom5Rule
```
private int custom5Rule
```
    custom5 Rule
  - addrStoreId
```
private java.lang.String addrStoreId
```
    addrStoreId
  - useDefaultWildCards
```
@Deprecated
private boolean useDefaultWildCards
```
    Deprecated. Use attribute rules instead
    
    Use default settings for wildcard searching when searching Strings. If false no wildcards ("%") are added for the search and an exact match is required
  - orderBy
```
private java.lang.String orderBy
```
    orderBy - Specify one of these to order the results:
    - AdminSearch.ORDER_BY_LASTNAME_ASCENDING
    - AdminSearch.ORDER_BY_LASTNAME_DESCENDING
    - AdminSearch.ORDER_BY_ID_ASCENDING (the default)
    - AdminSearch.ORDER_BY_ID_DESCENDING
  - formatAddresses
```
private boolean formatAddresses
```
    When set, the formattedAddress attribute of the Address objects is populated. The default value is false.
- Constructor Detail
  - AdminAddressSearch
```
public AdminAddressSearch()
```
    Instantiates an AdminAddressSearch object - a requirement for a bean class
  - AdminAddressSearch
```
public AdminAddressSearch(com.workingdogs.village.Record r,
                          com.konakart.db.KKCriteria c)
                   throws com.workingdogs.village.DataSetException
```
    Instantiates the attributes of the AdminAddressSearch object from a Record object
    
    Parameters:
    
    r - Record containing data
    
    c - Criteria containing column names
    
    Throws:
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Returns a string containing the attributes of the TaxRateSearch object.
  - toStringBrief
```
public java.lang.String toStringBrief()
```
    Returns:
    
    Returns a string containing the attributes of the TaxRate object.
  - getId
```
public int getId()
```
    Returns:
    
    Returns the id.
  - setId
```
public void setId(int id)
```
    Parameters:
    
    id - The id to set.
  - getOrderBy
```
public java.lang.String getOrderBy()
```
    Returns:
    
    Returns the orderBy.
  - setOrderBy
```
public void setOrderBy(java.lang.String orderBy)
```
    Parameters:
    
    orderBy - The orderBy to set.
  - isUseDefaultWildCards
```
@Deprecated
public boolean isUseDefaultWildCards()
```
    Deprecated. Use attribute rules instead
    
    Returns:
    
    the useDefaultWildCards
  - setUseDefaultWildCards
```
@Deprecated
public void setUseDefaultWildCards(boolean useDefaultWildCards)
```
    Deprecated. Use attribute rules instead
    
    Parameters:
    
    useDefaultWildCards - the useDefaultWildCards to set
  - getCustomerId
```
public int getCustomerId()
```
    Returns:
    
    the customerId
  - setCustomerId
```
public void setCustomerId(int customerId)
```
    Parameters:
    
    customerId - the customerId to set
  - getCustom1
```
public java.lang.String getCustom1()
```
    Returns:
    
    the custom1
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Parameters:
    
    custom1 - the custom1 to set
  - getCustom2
```
public java.lang.String getCustom2()
```
    Returns:
    
    the custom2
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Parameters:
    
    custom2 - the custom2 to set
  - getCountryId
```
public int getCountryId()
```
    Returns:
    
    the countryId
  - setCountryId
```
public void setCountryId(int countryId)
```
    Parameters:
    
    countryId - the countryId to set
  - getZoneId
```
public int getZoneId()
```
    Returns:
    
    the zoneId
  - setZoneId
```
public void setZoneId(int zoneId)
```
    Parameters:
    
    zoneId - the zoneId to set
  - getLastName
```
public java.lang.String getLastName()
```
    Returns:
    
    the lastName
  - setLastName
```
public void setLastName(java.lang.String lastName)
```
    Parameters:
    
    lastName - the lastName to set
  - getFirstName
```
public java.lang.String getFirstName()
```
    Returns:
    
    the firstName
  - setFirstName
```
public void setFirstName(java.lang.String firstName)
```
    Parameters:
    
    firstName - the firstName to set
  - getCompanyName
```
public java.lang.String getCompanyName()
```
    Returns:
    
    the companyName
  - setCompanyName
```
public void setCompanyName(java.lang.String companyName)
```
    Parameters:
    
    companyName - the companyName to set
  - getSuburb
```
public java.lang.String getSuburb()
```
    Returns:
    
    the suburb
  - setSuburb
```
public void setSuburb(java.lang.String suburb)
```
    Parameters:
    
    suburb - the suburb to set
  - getPostcode
```
public java.lang.String getPostcode()
```
    Returns:
    
    the postcode
  - setPostcode
```
public void setPostcode(java.lang.String postcode)
```
    Parameters:
    
    postcode - the postcode to set
  - getCity
```
public java.lang.String getCity()
```
    Returns:
    
    the city
  - setCity
```
public void setCity(java.lang.String city)
```
    Parameters:
    
    city - the city to set
  - getState
```
public java.lang.String getState()
```
    Returns:
    
    the state
  - setState
```
public void setState(java.lang.String state)
```
    Parameters:
    
    state - the state to set
  - getCustom3
```
public java.lang.String getCustom3()
```
    Returns:
    
    the custom3
  - setCustom3
```
public void setCustom3(java.lang.String custom3)
```
    Parameters:
    
    custom3 - the custom3 to set
  - getCustom4
```
public java.lang.String getCustom4()
```
    Returns:
    
    the custom4
  - setCustom4
```
public void setCustom4(java.lang.String custom4)
```
    Parameters:
    
    custom4 - the custom4 to set
  - getCustom5
```
public java.lang.String getCustom5()
```
    Returns:
    
    the custom5
  - setCustom5
```
public void setCustom5(java.lang.String custom5)
```
    Parameters:
    
    custom5 - the custom5 to set
  - getStreetAddress
```
public java.lang.String getStreetAddress()
```
    Returns:
    
    the streetAddress
  - setStreetAddress
```
public void setStreetAddress(java.lang.String streetAddress)
```
    Parameters:
    
    streetAddress - the streetAddress to set
  - getStreetAddressRule
```
public int getStreetAddressRule()
```
    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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the streetAddressRule
  - setStreetAddressRule
```
public void setStreetAddressRule(int streetAddressRule)
```
    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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    streetAddressRule - the streetAddressRule to set
  - getPostcodeRule
```
public int getPostcodeRule()
```
    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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the postcodeRule
  - setPostcodeRule
```
public void setPostcodeRule(int postcodeRule)
```
    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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    postcodeRule - the postcodeRule to set
  - getCityRule
```
public 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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the cityRule
  - setCityRule
```
public 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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    cityRule - the cityRule to set
  - getCustom1Rule
```
public 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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the custom1Rule
  - setCustom1Rule
```
public 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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    custom1Rule - the custom1Rule to set
  - getCustom2Rule
```
public 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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the custom2Rule
  - setCustom2Rule
```
public 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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    custom2Rule - the custom2Rule to set
  - getCustom3Rule
```
public 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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the custom3Rule
  - setCustom3Rule
```
public 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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    custom3Rule - the custom3Rule to set
  - getCustom4Rule
```
public int getCustom4Rule()
```
    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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the custom4Rule
  - setCustom4Rule
```
public void setCustom4Rule(int custom4Rule)
```
    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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    custom4Rule - the custom4Rule to set
  - getCustom5Rule
```
public int getCustom5Rule()
```
    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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the custom5Rule
  - setCustom5Rule
```
public void setCustom5Rule(int custom5Rule)
```
    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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    custom5Rule - the custom5Rule to set
  - getLastNameRule
```
public 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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the lastNameRule
  - setLastNameRule
```
public 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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    lastNameRule - the lastNameRule to set
  - getFirstNameRule
```
public 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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the firstNameRule
  - setFirstNameRule
```
public 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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    firstNameRule - the firstNameRule to set
  - getCompanyNameRule
```
public int getCompanyNameRule()
```
    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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the companyNameRule
  - setCompanyNameRule
```
public void setCompanyNameRule(int companyNameRule)
```
    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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    companyNameRule - the companyNameRule to set
  - getSuburbRule
```
public int getSuburbRule()
```
    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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the suburbRule
  - setSuburbRule
```
public void setSuburbRule(int suburbRule)
```
    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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    suburbRule - the suburbRule to set
  - getStateRule
```
public 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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the stateRule
  - setStateRule
```
public 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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    stateRule - the stateRule to set
  - getStreetAddress1
```
public java.lang.String getStreetAddress1()
```
    Returns:
    
    the streetAddress1
  - setStreetAddress1
```
public void setStreetAddress1(java.lang.String streetAddress1)
```
    Parameters:
    
    streetAddress1 - the streetAddress1 to set
  - getStreetAddress1Rule
```
public int getStreetAddress1Rule()
```
    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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Returns:
    
    the streetAddress1Rule
  - setStreetAddress1Rule
```
public void setStreetAddress1Rule(int streetAddress1Rule)
```
    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
    - KKConstants.SEARCH_USE_GLOBAL_CONFIG
    Parameters:
    
    streetAddress1Rule - the streetAddress1Rule to set
  - getProductId
```
public int getProductId()
```
    Returns:
    
    the productId
  - setProductId
```
public void setProductId(int productId)
```
    Parameters:
    
    productId - the productId to set
  - getManufacturerId
```
public int getManufacturerId()
```
    Returns:
    
    the manufacturerId
  - setManufacturerId
```
public void setManufacturerId(int manufacturerId)
```
    Parameters:
    
    manufacturerId - the manufacturerId to set
  - getType
```
public int getType()
```
    It can take the following values:
    - com.konakartadmin.bl.KonakartAdminConstants.ADDRESS_TYPE_CUSTOMER = A customer address
    - com.konakartadmin.bl.KonakartAdminConstants.ADDRESS_TYPE_PRODUCT = Address related to a product. Could be address of a drop shipper.
    - com.konakartadmin.bl.KonakartAdminConstants.ADDRESS_TYPE_MANUFACTURER = Address of a manufacturer.
    - com.konakartadmin.bl.KonakartAdminConstants.ADDRESS_TYPE_STORE = Address of a store.
    - com.konakartadmin.bl.KonakartAdminConstants.ADDRESS_TYPE_VENDOR = Address of a vendor.
    Returns:
    
    the type
  - setType
```
public void setType(int type)
```
    It can take the following values:
    - com.konakartadmin.bl.KonakartAdminConstants.ADDRESS_TYPE_CUSTOMER = A customer address
    - com.konakartadmin.bl.KonakartAdminConstants.ADDRESS_TYPE_PRODUCT = Address related to a product. Could be address of a drop shipper.
    - com.konakartadmin.bl.KonakartAdminConstants.ADDRESS_TYPE_MANUFACTURER = Address of a manufacturer.
    - com.konakartadmin.bl.KonakartAdminConstants.ADDRESS_TYPE_STORE = Address of a store.
    - com.konakartadmin.bl.KonakartAdminConstants.ADDRESS_TYPE_VENDOR = Address of a vendor.
    Parameters:
    
    type - the type to set
  - getStoreId
```
public java.lang.String getStoreId()
```
    Used to search for addresses associated with a store
    
    Returns:
    
    the storeId
  - setStoreId
```
public void setStoreId(java.lang.String storeId)
```
    Used to search for addresses associated with a store
    
    Parameters:
    
    storeId - the storeId to set
  - getAddrStoreId
```
public java.lang.String getAddrStoreId()
```
    Set with a valid storeId when searching for addresses for that store
    
    Returns:
    
    the addrStoreId
  - setAddrStoreId
```
public void setAddrStoreId(java.lang.String addrStoreId)
```
    Set with a valid storeId when searching for addresses for that store
    
    Parameters:
    
    addrStoreId - the addrStoreId to set
  - getVendorId
```
public int getVendorId()
```
    Returns:
    
    the vendorId
  - setVendorId
```
public void setVendorId(int vendorId)
```
    Parameters:
    
    vendorId - the vendorId to set
  - isFormatAddresses
```
public boolean isFormatAddresses()
```
    When set, the formattedAddress attribute of the Address objects is populated. The default value is false.
    
    Returns:
    
    the formatAddresses
  - setFormatAddresses
```
public void setFormatAddresses(boolean formatAddresses)
```
    When set, the formattedAddress attribute of the Address objects is populated. The default value is false.
    
    Parameters:
    
    formatAddresses - the formatAddresses to set

Class AdminAddressSearch

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

type

countryId

zoneId

customerId

productId

manufacturerId

vendorId

storeId

lastName

lastNameRule

firstName

firstNameRule

streetAddress

streetAddressRule

streetAddress1

streetAddress1Rule

companyName

companyNameRule

suburb

suburbRule

postcode

postcodeRule

city

cityRule

state

stateRule

custom1

custom2

custom3

custom4

custom5

custom1Rule

custom2Rule

custom3Rule

custom4Rule

custom5Rule

addrStoreId

useDefaultWildCards

orderBy

formatAddresses

Constructor Detail

AdminAddressSearch

AdminAddressSearch

Method Detail

toString

toStringBrief

getId

setId

getOrderBy

setOrderBy

isUseDefaultWildCards

setUseDefaultWildCards

getCustomerId

setCustomerId

getCustom1

setCustom1

getCustom2

setCustom2

getCountryId

setCountryId

getZoneId

setZoneId

getLastName

setLastName

getFirstName

setFirstName

getCompanyName

setCompanyName

getSuburb

setSuburb

getPostcode

setPostcode

getCity