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

Interface FetchOrdersCmd

All Superinterfaces:

com.ibm.websphere.command.Command, java.io.Serializable

All Known Implementing Classes:

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

public interface FetchOrdersCmd
extends com.ibm.websphere.command.Command

This task command retrieves 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$)]]
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_IBMORD_ISCURRENTSHOPPINGCART The string of ibmord.isCurrentShoppingCart parameter.
static java.lang.String	_STR_ORDER_ID_PARAMETER The string of Order Id.
static java.lang.String	_STR_STATUS_PARAMETER The string of status parameter.
static java.lang.String	_STR_STATUS_SEPARATOR The string of status separator.
static java.lang.String	_STR_TYPE_PARAMETER The string of type parameter.
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	defaultCommandClassName The default implementation class name.
static java.lang.String	NAME The full class name for this interface file.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.util.List	getOrders() This method returns a list of found orders.
ShowType	getPagingParameters() Returns the paging parameters.
ShowType	getPagingPrameter() Deprecated. Use getPagingParameters() instead.
void	setGetOrder(GetOrderType getOrder) This method sets the GetOrder.
void	setPagingParameters(ShowType newPagingParameters) Sets the paging parameters.
void	setPagingPrameter(ShowType argPagingParameter) Deprecated. Use setPagingParameters(ShowType) instead.

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

execute, isReadyToCallExecute, reset

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The full class name for this interface file.

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation class name. This is used if there is no record found in the CMDREG table.

_STR_STATUS_PARAMETER

static final java.lang.String _STR_STATUS_PARAMETER

The string of status parameter.

See Also:

Constant Field Values

_STR_TYPE_PARAMETER

static final java.lang.String _STR_TYPE_PARAMETER

The string of type parameter.

See Also:

Constant Field Values

_IBMORD_ISCURRENTSHOPPINGCART

static final java.lang.String _IBMORD_ISCURRENTSHOPPINGCART

The string of ibmord.isCurrentShoppingCart parameter.

See Also:

Constant Field Values

_STR_ORDER_ID_PARAMETER

static final java.lang.String _STR_ORDER_ID_PARAMETER

The string of Order Id.

See Also:

Constant Field Values

_STR_STATUS_SEPARATOR

static final java.lang.String _STR_STATUS_SEPARATOR

The string of status separator.

See Also:

Constant Field Values

Method Detail

getOrders

java.util.List getOrders()

This method returns a list of found orders.

Returns:

list of OrderAccessBean objects.

setGetOrder

void setGetOrder(GetOrderType getOrder)

This method sets the GetOrder.

Parameters:

getOrder - the GetOrderType to set

getPagingPrameter

ShowType getPagingPrameter()

Deprecated. Use getPagingParameters() instead.

Returns the paging parameters.

Returns:

the paging parameters.

setPagingPrameter

void setPagingPrameter(ShowType argPagingParameter)

Deprecated. Use setPagingParameters(ShowType) instead.

Sets the paging parameters.

Parameters:

argPagingParameter - The paging parameters to set.

getPagingParameters

ShowType getPagingParameters()

Returns the paging parameters.

Returns:

the paging parameters.

setPagingParameters

void setPagingParameters(ShowType newPagingParameters)

Sets the paging parameters.

Parameters:

newPagingParameters - The paging parameters to set.