com.ibm.commerce.order.client.commands

Interface GetOrderCmd

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Implementing Classes:

GetOrderCmdImpl

public interface GetOrderCmd
extends TaskCommand

This order client task command is used to retrieve an order or list of orders from an external system by composing a GetOrder SDO from the search criteria specified and make the GetOrderservice request with it and the invocation service action specified. The default implementation of this command is GetOrderCmdImpl.

See Also:

OrderClientFacadeImpl, InvocationService

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_GET_ORDER The invocation service action GetOrder.
static java.lang.String	COPYRIGHT The IBM copyright notice field.
static java.lang.String	defaultCommandClassName The default implementation of this command.
static java.lang.String	NAME The full name of this command.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
com.ibm.commerce.order.datatypes.OrderType[]	getOrders() Returns the orders.
java.lang.Integer	getTotalNumberOfOrdersFound() Returns the total number of orders found.
void	setAction(java.lang.String astrAction) Sets the invocation service action.
void	setBeginIndex(java.lang.Integer anBeginIndex) Sets the begin index.
void	setBuyerOrganizationId(java.lang.Long anBuyerOrganizationId) Sets the buyer organization ID.
void	setCustomerId(java.lang.Long anCustomerId) Sets the customer ID.
void	setCustomerOrderNumber(java.lang.String astrCustomerOrderNumber) Sets the customer order number.
void	setEndIndex(java.lang.Integer anEndIndex) Sets the end index.
void	setExternalOrderId(java.lang.String astrExternalOrderId) Sets the external order ID.
void	setOrderId(java.lang.Long anOrderId) Sets the order ID.

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

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

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

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

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

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

isReadyToCallExecute, reset

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

unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

The IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The full name of this command.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation of this command.

See Also:

Constant Field Values

ACTION_GET_ORDER

static final java.lang.String ACTION_GET_ORDER

The invocation service action GetOrder.

See Also:

Constant Field Values

Method Detail

setAction

void setAction(java.lang.String astrAction)

Sets the invocation service action.

Parameters:

astrAction - the invocation service action.

setOrderId

void setOrderId(java.lang.Long anOrderId)

Sets the order ID.

Parameters:

anOrderId - the order ID.

setExternalOrderId

void setExternalOrderId(java.lang.String astrExternalOrderId)

Sets the external order ID.

Parameters:

astrExternalOrderId - the external order ID.

setCustomerOrderNumber

void setCustomerOrderNumber(java.lang.String astrCustomerOrderNumber)

Sets the customer order number.

Parameters:

astrCustomerOrderNumber - the customer order number.

setBuyerOrganizationId

void setBuyerOrganizationId(java.lang.Long anBuyerOrganizationId)

Sets the buyer organization ID.

Parameters:

anBuyerOrganizationId - the buyer organization ID.

setCustomerId

void setCustomerId(java.lang.Long anCustomerId)

Sets the customer ID.

Parameters:

anCustomerID - the customer ID.

setBeginIndex

void setBeginIndex(java.lang.Integer anBeginIndex)

Sets the begin index.

Parameters:

anBeginIndex - the begin index (one-based, inclusive).

setEndIndex

void setEndIndex(java.lang.Integer anEndIndex)

Sets the end index.

Parameters:

anEndIndex - the end index (one-based, inclusive).

getTotalNumberOfOrdersFound

java.lang.Integer getTotalNumberOfOrdersFound()

Returns the total number of orders found.

Returns:

the total number of orders found.

getOrders

com.ibm.commerce.order.datatypes.OrderType[] getOrders()

Returns the orders.

Returns:

the orders.