OrderSearchIf (KonaKart Server Engine API Documentation)

All Known Implementing Classes:

OrderSearch
```
public interface OrderSearchIf
```
Contains information used to search for orders

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAffiliateId()` Identifier of the affiliate partner
`int`	`getAffiliateIdRule()` The rule for the search.
`java.lang.String`	`getCreator()` Identifier of the administrator who created the order
`int`	`getCreatorRule()` The rule for the search.
`java.util.Calendar`	`getDateAddedFrom()`
`java.util.Calendar`	`getDateAddedTo()`
`int[]`	`getExcludeStatusIds()` Order Status ids to exclude from the search
`java.lang.String[]`	`getIncludeArchiveIds()` Archive ids to include in the search
`int[]`	`getIncludeStatusIds()` Only return orders with status id equal to one of the integers in the array
`java.util.Calendar`	`getLastModifiedFrom()`
`java.util.Calendar`	`getLastModifiedTo()`
`int`	`getOrderId()` OrderId to search for a single order
`java.lang.String`	`getOrderNumber()` Order Number to search for a single order
`int`	`getParentId()` ParentId used in multi-vendor mode to search for vendor orders associated with the main order
`boolean`	`isIncludeAllChildrenCustomerOrders()` Includes all orders of the customer's children, grandchildren etc.
`boolean`	`isIncludeChildrenCustomerOrders()` Includes all orders of the customers direct children, but not from any children they may have
`boolean`	`isIncludeParentCustomerOrders()` Includes all orders of the customer's parent
`boolean`	`isIncludeSiblingCustomerOrders()` Includes all orders of the customer's siblings (customers sharing the same parent customer)
`boolean`	`isPopulateArchivedOrdersAttribute()` Fetches all archived orders for an order and adds them to the ArchivedOrders attribute.
`void`	`setAffiliateId(java.lang.String affiliateId)` Identifier of the affiliate partner
`void`	`setAffiliateIdRule(int affiliateIdRule)` The rule for the search.
`void`	`setCreator(java.lang.String creator)` Identifier of the administrator who created the order
`void`	`setCreatorRule(int creatorRule)` The rule for the search.
`void`	`setDateAddedFrom(java.util.Calendar dateAddedFrom)`
`void`	`setDateAddedTo(java.util.Calendar dateAddedTo)`
`void`	`setExcludeStatusIds(int[] excludeStatusIds)` Order Status ids to exclude from the search
`void`	`setIncludeAllChildrenCustomerOrders(boolean includeAllChildrenCustomerOrders)` Includes all orders of the customer's children, grandchildren etc.
`void`	`setIncludeArchiveIds(java.lang.String[] includeArchiveIds)` Archive ids to include in the search
`void`	`setIncludeChildrenCustomerOrders(boolean includeChildrenCustomerOrders)` Includes all orders of the customers direct children, but not from any children they may have
`void`	`setIncludeParentCustomerOrders(boolean includeParentCustomerOrders)` Includes all orders of the customer's parent
`void`	`setIncludeSiblingCustomerOrders(boolean includeSiblingCustomerOrders)` Includes all orders of the customer's siblings (customers sharing the same parent customer)
`void`	`setIncludeStatusIds(int[] includeStatusIds)` Only return orders with status id equal to one of the integers in the array
`void`	`setLastModifiedFrom(java.util.Calendar lastModifiedFrom)`
`void`	`setLastModifiedTo(java.util.Calendar lastModifiedTo)`
`void`	`setOrderId(int orderId)` OrderId to search for a single order
`void`	`setOrderNumber(java.lang.String orderNumber)` Order Number to search for a single order
`void`	`setParentId(int parentId)` ParentId used in multi-vendor mode to search for vendor orders associated with the main order
`void`	`setPopulateArchivedOrdersAttribute(boolean populateArchivedOrdersAttribute)` Fetches all archived orders for an order and adds them to the ArchivedOrders attribute.

- Method Detail
  - getDateAddedFrom
```
java.util.Calendar getDateAddedFrom()
```
    Returns:
    
    the dateAddedFrom
  - setDateAddedFrom
```
void setDateAddedFrom(java.util.Calendar dateAddedFrom)
```
    Parameters:
    
    dateAddedFrom - the dateAddedFrom to set
  - getDateAddedTo
```
java.util.Calendar getDateAddedTo()
```
    Returns:
    
    the dateAddedTo
  - setDateAddedTo
```
void setDateAddedTo(java.util.Calendar dateAddedTo)
```
    Parameters:
    
    dateAddedTo - the dateAddedTo to set
  - getIncludeStatusIds
```
int[] getIncludeStatusIds()
```
    Only return orders with status id equal to one of the integers in the array
    
    Returns:
    
    the includeStatusIds
  - setIncludeStatusIds
```
void setIncludeStatusIds(int[] includeStatusIds)
```
    Only return orders with status id equal to one of the integers in the array
    
    Parameters:
    
    includeStatusIds - the includeStatusIds to set
  - getCreator
```
java.lang.String getCreator()
```
    Identifier of the administrator who created the order
    
    Returns:
    
    the creator
  - setCreator
```
void setCreator(java.lang.String creator)
```
    Identifier of the administrator who created the order
    
    Parameters:
    
    creator - the creator to set
  - getCreatorRule
```
int getCreatorRule()
```
    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 creatorRule
  - setCreatorRule
```
void setCreatorRule(int creatorRule)
```
    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:
    
    creatorRule - the creatorRule to set
  - getAffiliateId
```
java.lang.String getAffiliateId()
```
    Identifier of the affiliate partner
    
    Returns:
    
    the affiliateId
  - setAffiliateId
```
void setAffiliateId(java.lang.String affiliateId)
```
    Identifier of the affiliate partner
    
    Parameters:
    
    affiliateId - the affiliateId to set
  - getAffiliateIdRule
```
int getAffiliateIdRule()
```
    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 affiliateIdRule
  - setAffiliateIdRule
```
void setAffiliateIdRule(int affiliateIdRule)
```
    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:
    
    affiliateIdRule - the affiliateIdRule to set
  - getParentId
```
int getParentId()
```
    ParentId used in multi-vendor mode to search for vendor orders associated with the main order
    
    Returns:
    
    the parentId
  - setParentId
```
void setParentId(int parentId)
```
    ParentId used in multi-vendor mode to search for vendor orders associated with the main order
    
    Parameters:
    
    parentId - the parentId to set
  - getLastModifiedFrom
```
java.util.Calendar getLastModifiedFrom()
```
    Returns:
    
    the lastModifiedFrom
  - setLastModifiedFrom
```
void setLastModifiedFrom(java.util.Calendar lastModifiedFrom)
```
    Parameters:
    
    lastModifiedFrom - the lastModifiedFrom to set
  - getLastModifiedTo
```
java.util.Calendar getLastModifiedTo()
```
    Returns:
    
    the lastModifiedTo
  - setLastModifiedTo
```
void setLastModifiedTo(java.util.Calendar lastModifiedTo)
```
    Parameters:
    
    lastModifiedTo - the lastModifiedTo to set
  - isIncludeParentCustomerOrders
```
boolean isIncludeParentCustomerOrders()
```
    Includes all orders of the customer's parent
    
    Returns:
    
    the includeParentCustomerOrders
  - setIncludeParentCustomerOrders
```
void setIncludeParentCustomerOrders(boolean includeParentCustomerOrders)
```
    Includes all orders of the customer's parent
    
    Parameters:
    
    includeParentCustomerOrders - the includeParentCustomerOrders to set
  - isIncludeSiblingCustomerOrders
```
boolean isIncludeSiblingCustomerOrders()
```
    Includes all orders of the customer's siblings (customers sharing the same parent customer)
    
    Returns:
    
    the includeSiblingCustomerOrders
  - setIncludeSiblingCustomerOrders
```
void setIncludeSiblingCustomerOrders(boolean includeSiblingCustomerOrders)
```
    Includes all orders of the customer's siblings (customers sharing the same parent customer)
    
    Parameters:
    
    includeSiblingCustomerOrders - the includeSiblingCustomerOrders to set
  - isIncludeChildrenCustomerOrders
```
boolean isIncludeChildrenCustomerOrders()
```
    Includes all orders of the customers direct children, but not from any children they may have
    
    Returns:
    
    the includeChildrenCustomerOrders
  - setIncludeChildrenCustomerOrders
```
void setIncludeChildrenCustomerOrders(boolean includeChildrenCustomerOrders)
```
    Includes all orders of the customers direct children, but not from any children they may have
    
    Parameters:
    
    includeChildrenCustomerOrders - the includeChildrenCustomerOrders to set
  - isIncludeAllChildrenCustomerOrders
```
boolean isIncludeAllChildrenCustomerOrders()
```
    Includes all orders of the customer's children, grandchildren etc.
    
    Returns:
    
    the includeAllChildrenCustomerOrders
  - setIncludeAllChildrenCustomerOrders
```
void setIncludeAllChildrenCustomerOrders(boolean includeAllChildrenCustomerOrders)
```
    Includes all orders of the customer's children, grandchildren etc.
    
    Parameters:
    
    includeAllChildrenCustomerOrders - the includeAllChildrenCustomerOrders to set
  - getOrderId
```
int getOrderId()
```
    OrderId to search for a single order
    
    Returns:
    
    the orderId
  - setOrderId
```
void setOrderId(int orderId)
```
    OrderId to search for a single order
    
    Parameters:
    
    orderId - the orderId to set
  - getIncludeArchiveIds
```
java.lang.String[] getIncludeArchiveIds()
```
    Archive ids to include in the search
    
    Returns:
    
    the includeArchiveIds
  - setIncludeArchiveIds
```
void setIncludeArchiveIds(java.lang.String[] includeArchiveIds)
```
    Archive ids to include in the search
    
    Parameters:
    
    includeArchiveIds - the includeArchiveIds to set
  - getExcludeStatusIds
```
int[] getExcludeStatusIds()
```
    Order Status ids to exclude from the search
    
    Returns:
    
    the excludeStatusIds
  - setExcludeStatusIds
```
void setExcludeStatusIds(int[] excludeStatusIds)
```
    Order Status ids to exclude from the search
    
    Parameters:
    
    excludeStatusIds - the excludeStatusIds to set
  - isPopulateArchivedOrdersAttribute
```
boolean isPopulateArchivedOrdersAttribute()
```
    Fetches all archived orders for an order and adds them to the ArchivedOrders attribute.
    
    Returns:
    
    the populateArchivedOrdersAttribute
  - setPopulateArchivedOrdersAttribute
```
void setPopulateArchivedOrdersAttribute(boolean populateArchivedOrdersAttribute)
```
    Fetches all archived orders for an order and adds them to the ArchivedOrders attribute.
    
    Parameters:
    
    populateArchivedOrdersAttribute - the populateArchivedOrdersAttribute to set
  - getOrderNumber
```
java.lang.String getOrderNumber()
```
    Order Number to search for a single order
    
    Returns:
    
    the orderNumber
  - setOrderNumber
```
void setOrderNumber(java.lang.String orderNumber)
```
    Order Number to search for a single order
    
    Parameters:
    
    orderNumber - the orderNumber to set

Interface OrderSearchIf

Method Summary

Method Detail

getDateAddedFrom

setDateAddedFrom

getDateAddedTo

setDateAddedTo

getIncludeStatusIds

setIncludeStatusIds

getCreator

setCreator

getCreatorRule

setCreatorRule

getAffiliateId

setAffiliateId

getAffiliateIdRule

setAffiliateIdRule

getParentId

setParentId

getLastModifiedFrom

setLastModifiedFrom

getLastModifiedTo

setLastModifiedTo

isIncludeParentCustomerOrders

setIncludeParentCustomerOrders

isIncludeSiblingCustomerOrders

setIncludeSiblingCustomerOrders

isIncludeChildrenCustomerOrders

setIncludeChildrenCustomerOrders

isIncludeAllChildrenCustomerOrders

setIncludeAllChildrenCustomerOrders

getOrderId

setOrderId

getIncludeArchiveIds

setIncludeArchiveIds

getExcludeStatusIds

setExcludeStatusIds

isPopulateArchivedOrdersAttribute

setPopulateArchivedOrdersAttribute

getOrderNumber

setOrderNumber