com.konakart.app

Class OrderSearch

java.lang.Object

com.konakart.app.OrderSearch

All Implemented Interfaces:

OrderSearchIf

public class OrderSearch
extends java.lang.Object
implements OrderSearchIf

OrderSearch object

Constructor Summary

Constructors

Constructor and Description
OrderSearch() Constructor

Method Summary

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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OrderSearch

public OrderSearch()

Constructor

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

Returns a string containing the attributes of the Product object and those of its Options.

getDateAddedFrom

public java.util.Calendar getDateAddedFrom()

Specified by:

getDateAddedFrom in interface OrderSearchIf

Returns:

the dateAddedFrom

setDateAddedFrom

public void setDateAddedFrom(java.util.Calendar dateAddedFrom)

Specified by:

setDateAddedFrom in interface OrderSearchIf

Parameters:

dateAddedFrom - the dateAddedFrom to set

getDateAddedTo

public java.util.Calendar getDateAddedTo()

Specified by:

getDateAddedTo in interface OrderSearchIf

Returns:

the dateAddedTo

setDateAddedTo

public void setDateAddedTo(java.util.Calendar dateAddedTo)

Specified by:

setDateAddedTo in interface OrderSearchIf

Parameters:

dateAddedTo - the dateAddedTo to set

getIncludeStatusIds

public int[] getIncludeStatusIds()

Description copied from interface: OrderSearchIf

Only return orders with status id equal to one of the integers in the array

Specified by:

getIncludeStatusIds in interface OrderSearchIf

Returns:

the includeStatusIds

setIncludeStatusIds

public void setIncludeStatusIds(int[] includeStatusIds)

Description copied from interface: OrderSearchIf

Only return orders with status id equal to one of the integers in the array

Specified by:

setIncludeStatusIds in interface OrderSearchIf

Parameters:

includeStatusIds - the includeStatusIds to set

getCreator

public java.lang.String getCreator()

Identifier of the administrator who created the order

Specified by:

getCreator in interface OrderSearchIf

Returns:

the creator

setCreator

public void setCreator(java.lang.String creator)

Identifier of the administrator who created the order

Specified by:

setCreator in interface OrderSearchIf

Parameters:

creator - the creator to set

getCreatorRule

public int getCreatorRule()

Description copied from interface: OrderSearchIf

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:

getCreatorRule in interface OrderSearchIf

Returns:

the creatorRule

setCreatorRule

public void setCreatorRule(int creatorRule)

Description copied from interface: OrderSearchIf

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:

setCreatorRule in interface OrderSearchIf

Parameters:

creatorRule - the creatorRule to set

getAffiliateId

public java.lang.String getAffiliateId()

Identifier of the affiliate partner

Specified by:

getAffiliateId in interface OrderSearchIf

Returns:

the affiliateId

setAffiliateId

public void setAffiliateId(java.lang.String affiliateId)

Identifier of the affiliate partner

Specified by:

setAffiliateId in interface OrderSearchIf

Parameters:

affiliateId - the affiliateId to set

getAffiliateIdRule

public int getAffiliateIdRule()

Description copied from interface: OrderSearchIf

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:

getAffiliateIdRule in interface OrderSearchIf

Returns:

the affiliateIdRule

setAffiliateIdRule

public void setAffiliateIdRule(int affiliateIdRule)

Description copied from interface: OrderSearchIf

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:

setAffiliateIdRule in interface OrderSearchIf

Parameters:

affiliateIdRule - the affiliateIdRule to set

getParentId

public int getParentId()

ParentId used in multi-vendor mode to search for vendor orders associated with the main order

Specified by:

getParentId in interface OrderSearchIf

Returns:

the parentId

setParentId

public void setParentId(int parentId)

ParentId used in multi-vendor mode to search for vendor orders associated with the main order

Specified by:

setParentId in interface OrderSearchIf

Parameters:

parentId - the parentId to set

getLastModifiedFrom

public java.util.Calendar getLastModifiedFrom()

Specified by:

getLastModifiedFrom in interface OrderSearchIf

Returns:

the lastModifiedFrom

setLastModifiedFrom

public void setLastModifiedFrom(java.util.Calendar lastModifiedFrom)

Specified by:

setLastModifiedFrom in interface OrderSearchIf

Parameters:

lastModifiedFrom - the lastModifiedFrom to set

getLastModifiedTo

public java.util.Calendar getLastModifiedTo()

Specified by:

getLastModifiedTo in interface OrderSearchIf

Returns:

the lastModifiedTo

setLastModifiedTo

public void setLastModifiedTo(java.util.Calendar lastModifiedTo)

Specified by:

setLastModifiedTo in interface OrderSearchIf

Parameters:

lastModifiedTo - the lastModifiedTo to set

isIncludeParentCustomerOrders

public boolean isIncludeParentCustomerOrders()

Includes all orders of the customer's parent

Specified by:

isIncludeParentCustomerOrders in interface OrderSearchIf

Returns:

the includeParentCustomerOrders

setIncludeParentCustomerOrders

public void setIncludeParentCustomerOrders(boolean includeParentCustomerOrders)

Includes all orders of the customer's parent

Specified by:

setIncludeParentCustomerOrders in interface OrderSearchIf

Parameters:

includeParentCustomerOrders - the includeParentCustomerOrders to set

isIncludeSiblingCustomerOrders

public boolean isIncludeSiblingCustomerOrders()

Includes all orders of the customer's siblings (customers sharing the same parent customer)

Specified by:

isIncludeSiblingCustomerOrders in interface OrderSearchIf

Returns:

the includeSiblingCustomerOrders

setIncludeSiblingCustomerOrders

public void setIncludeSiblingCustomerOrders(boolean includeSiblingCustomerOrders)

Includes all orders of the customer's siblings (customers sharing the same parent customer)

Specified by:

setIncludeSiblingCustomerOrders in interface OrderSearchIf

Parameters:

includeSiblingCustomerOrders - the includeSiblingCustomerOrders to set

isIncludeAllChildrenCustomerOrders

public boolean isIncludeAllChildrenCustomerOrders()

Includes all orders of the customer's children, grandchildren etc.

Specified by:

isIncludeAllChildrenCustomerOrders in interface OrderSearchIf

Returns:

the includeAllChildrenCustomerOrders

setIncludeAllChildrenCustomerOrders

public void setIncludeAllChildrenCustomerOrders(boolean includeAllChildrenCustomerOrders)

Includes all orders of the customer's children, grandchildren etc.

Specified by:

setIncludeAllChildrenCustomerOrders in interface OrderSearchIf

Parameters:

includeAllChildrenCustomerOrders - the includeAllChildrenCustomerOrders to set

isIncludeChildrenCustomerOrders

public boolean isIncludeChildrenCustomerOrders()

Includes all orders of the customers direct children, but not from any children they may have

Specified by:

isIncludeChildrenCustomerOrders in interface OrderSearchIf

Returns:

the includeChildrenCustomerOrders

setIncludeChildrenCustomerOrders

public void setIncludeChildrenCustomerOrders(boolean includeChildrenCustomerOrders)

Includes all orders of the customers direct children, but not from any children they may have

Specified by:

setIncludeChildrenCustomerOrders in interface OrderSearchIf

Parameters:

includeChildrenCustomerOrders - the includeChildrenCustomerOrders to set

getOrderId

public int getOrderId()

OrderId to search for a single order

Specified by:

getOrderId in interface OrderSearchIf

Returns:

the orderId

setOrderId

public void setOrderId(int orderId)

OrderId to search for a single order

Specified by:

setOrderId in interface OrderSearchIf

Parameters:

orderId - the orderId to set

getIncludeArchiveIds

public java.lang.String[] getIncludeArchiveIds()

Archive ids to include in the search

Specified by:

getIncludeArchiveIds in interface OrderSearchIf

Returns:

the includeArchiveIds

setIncludeArchiveIds

public void setIncludeArchiveIds(java.lang.String[] includeArchiveIds)

Archive ids to include in the search

Specified by:

setIncludeArchiveIds in interface OrderSearchIf

Parameters:

includeArchiveIds - the includeArchiveIds to set

getExcludeStatusIds

public int[] getExcludeStatusIds()

Order Status ids to exclude from the search

Specified by:

getExcludeStatusIds in interface OrderSearchIf

Returns:

the excludeStatusIds

setExcludeStatusIds

public void setExcludeStatusIds(int[] excludeStatusIds)

Order Status ids to exclude from the search

Specified by:

setExcludeStatusIds in interface OrderSearchIf

Parameters:

excludeStatusIds - the excludeStatusIds to set

isPopulateArchivedOrdersAttribute

public boolean isPopulateArchivedOrdersAttribute()

Fetches all archived orders for an order and adds them to the ArchivedOrders attribute.

Specified by:

isPopulateArchivedOrdersAttribute in interface OrderSearchIf

Returns:

the populateArchivedOrdersAttribute

setPopulateArchivedOrdersAttribute

public void setPopulateArchivedOrdersAttribute(boolean populateArchivedOrdersAttribute)

Fetches all archived orders for an order and adds them to the ArchivedOrders attribute.

Specified by:

setPopulateArchivedOrdersAttribute in interface OrderSearchIf

Parameters:

populateArchivedOrdersAttribute - the populateArchivedOrdersAttribute to set

getOrderNumber

public java.lang.String getOrderNumber()

Order Number to search for a single order

Specified by:

getOrderNumber in interface OrderSearchIf

Returns:

the orderNumber

setOrderNumber

public void setOrderNumber(java.lang.String orderNumber)

Order Number to search for a single order

Specified by:

setOrderNumber in interface OrderSearchIf

Parameters:

orderNumber - the orderNumber to set