com.ibm.commerce.order.facade.server.commands

Class AbstractFetchOrdersSOICmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.order.facade.server.commands.AbstractFetchOrdersSOICmdImpl

All Implemented Interfaces:

FetchOrdersCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

Direct Known Subclasses:

FetchChildOrdersByParentOrderIdCmdImpl, FetchChildOrdersByParentOrderItemIdCmdImpl, FetchConfigurationByOrderItemIdCmdImpl, com.ibm.commerce.order.facade.server.commands.FetchExternalOrderByStoreMemberAndStatusCmdImpl, FetchOrderByExternalOrderIdCmdImpl, FetchOrderByStoreIdPlaceDateMemberIdAndStatusCmdImpl, FetchOrderItemByStoreIdCreateDateMemberIdAndStatusCmdImpl, FetchOrdersByExtParameterCmdImpl, FetchOrdersByIdentifierCmdImpl, FetchOrdersByStatusAndTypeCmdImpl, FetchOrdersByStatusCmdImpl

public abstract class AbstractFetchOrdersSOICmdImpl
extends com.ibm.websphere.command.CacheableCommandImpl
implements FetchOrdersCmd

This command is the base command of those command that retrieve a list of orders according to the search criteria specified by the client. The list contains OrderAccessBean objects populated with all the available data. The search criteria are specified by the input XPath queries.

The following XPath queries can be processed by this command:

 /Order[OrderStatus[(Status=$status$)]]
 {ibmord.isCurrentShoppingCart=$isCurrentShoppingCart$}/Order
 /Order[OrderIdentifier[(UniqueID=$orderId$)]]
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.util.logging.Logger	LOGGER The logger of the class.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.order.facade.server.commands.FetchOrdersCmd

_IBMORD_ISCURRENTSHOPPINGCART, _STR_ORDER_ID_PARAMETER, _STR_STATUS_PARAMETER, _STR_STATUS_SEPARATOR, _STR_TYPE_PARAMETER, defaultCommandClassName, NAME

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AbstractFetchOrdersSOICmdImpl()

Method Summary

Modifier and Type	Method and Description
GetOrderType	getGetOrderType() This method gets the value of GetOrderType.
java.util.List	getOrders() This method gets the list of order access beans.
java.util.List	getOrders(java.util.List vOrders, java.math.BigInteger recordSetStartNumber, java.math.BigInteger maxItems) This methods gets a certain number of orders, with pagination performed.
ShowType	getPagingParameters() Returns the paging parameters.
ShowType	getPagingPrameter() Deprecated. Use getPagingParameters() instead.
ResolveOrdersCmd	getResolveOrdersCmd() This method returns the instance of ResolveOrdersCmd.
SelectionCriteriaMapper	getSelectionCriteria() This method gets the selection criteria.
boolean	isReadyToCallExecute()
void	performExecute()
void	reset()
void	setGetOrder(GetOrderType getOrder) This method sets the value of GetOrderType.
void	setPagingParameters(ShowType newPagingParameters) Sets the paging parameters.
void	setPagingPrameter(ShowType argPagingParameter) Deprecated. Use setPagingParameters(ShowType) instead.
void	setSelectionCriteria(SelectionCriteriaMapper aSelectionCriteria) This method set the selection criteria.

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

execute, executeFromCache, getCaller, getEntryInfo, getId, getObjectSize, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.websphere.command.Command

execute

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

LOGGER

public static final java.util.logging.Logger LOGGER

The logger of the class.

Constructor Detail

AbstractFetchOrdersSOICmdImpl

public AbstractFetchOrdersSOICmdImpl()

Method Detail

isReadyToCallExecute

public boolean isReadyToCallExecute()

Specified by:

isReadyToCallExecute in interface com.ibm.websphere.command.Command

Specified by:

isReadyToCallExecute in class com.ibm.websphere.command.TargetableCommandImpl

See Also:

Command.isReadyToCallExecute()

reset

public void reset()

Specified by:

reset in interface com.ibm.websphere.command.Command

Overrides:

reset in class com.ibm.websphere.command.CacheableCommandImpl

See Also:

Command.reset()

setGetOrder

public void setGetOrder(GetOrderType getOrder)

This method sets the value of GetOrderType.

Specified by:

setGetOrder in interface FetchOrdersCmd

Parameters:

getOrder -

getGetOrderType

public GetOrderType getGetOrderType()

This method gets the value of GetOrderType.

Returns:

the value of GetOrderType

getOrders

public java.util.List getOrders()

This method gets the list of order access beans.

Specified by:

getOrders in interface FetchOrdersCmd

Returns:

the list of order access beans

getOrders

public java.util.List getOrders(java.util.List vOrders,
                                java.math.BigInteger recordSetStartNumber,
                                java.math.BigInteger maxItems)

This methods gets a certain number of orders, with pagination performed.

Parameters:

vOrders - A list of orders.

recordSetStartNumber - The desired start position that was passed in the request.

maxItems - The desired page size that was passed in the request.

Returns:

A list of orders.

performExecute

public void performExecute()
                    throws java.lang.Exception

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Specified by:

performExecute in class com.ibm.websphere.command.TargetableCommandImpl

Throws:

java.lang.Exception

See Also:

TargetableCommandImpl.performExecute()

getResolveOrdersCmd

public ResolveOrdersCmd getResolveOrdersCmd()

This method returns the instance of ResolveOrdersCmd.

Returns:

the instance of ResolveOrdersCmd.

getPagingPrameter

public ShowType getPagingPrameter()

Deprecated. Use getPagingParameters() instead.

Returns the paging parameters.

Specified by:

getPagingPrameter in interface FetchOrdersCmd

Returns:

the paging parameters.

setPagingPrameter

public void setPagingPrameter(ShowType argPagingParameter)

Deprecated. Use setPagingParameters(ShowType) instead.

Sets the paging parameters.

Specified by:

setPagingPrameter in interface FetchOrdersCmd

Parameters:

argPagingParameter - The paging parameters to set.

getPagingParameters

public ShowType getPagingParameters()

Returns the paging parameters.

Specified by:

getPagingParameters in interface FetchOrdersCmd

Returns:

the paging parameters.

setPagingParameters

public void setPagingParameters(ShowType newPagingParameters)

Sets the paging parameters.

Specified by:

setPagingParameters in interface FetchOrdersCmd

Parameters:

newPagingParameters - The paging parameters to set.

getSelectionCriteria

public SelectionCriteriaMapper getSelectionCriteria()

This method gets the selection criteria.

Returns:

Returns the selection criteria.

setSelectionCriteria

public void setSelectionCriteria(SelectionCriteriaMapper aSelectionCriteria)

This method set the selection criteria.

Parameters:

aSelectionCriteria - The selection criteria to set.