com.ibm.commerce.order.commands

Interface GetCurrentPendingOrdersCmd

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:

GetCurrentPendingOrdersCmdImpl

public interface GetCurrentPendingOrdersCmd
extends TaskCommand

Obtains a list of current pending orders for a Member.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	defaultCommandClassName The name of the default implementation class for this command interface.
static java.lang.String	NAME The name of this command interface.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.util.Enumeration	getOrderList() Returns the list of current pending order identifiers.
boolean	getResult() Checks if the result is valid.
void	setMemberId(java.lang.Long aMemberId) Sets the identifier of the Member whose current pending Orders are to be retrieved.
void	setOrderByLastUpdate(boolean aByLastUpdate) Sets the flag to indicate that Orders should be retrieved in ascending sequence.
void	setStoreId(java.lang.Integer aStoreId) Sets the identifier of the Store that owns the pending Orders.

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

IBM Copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this command interface.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The name of the default implementation class for this command interface.

See Also:

Constant Field Values

Method Detail

getOrderList

java.util.Enumeration getOrderList()

Returns the list of current pending order identifiers.

Returns:

Enumeration of OrderAccessBean.

getResult

boolean getResult()

Checks if the result is valid.

Returns:

true indicates the performExecute method has completed successfully.

setMemberId

void setMemberId(java.lang.Long aMemberId)

Sets the identifier of the Member whose current pending Orders are to be retrieved.

Parameters:

aMemberId - mandatory. The identifier of the Member whose current pending Orders are to be retrieved.

setOrderByLastUpdate

void setOrderByLastUpdate(boolean aByLastUpdate)

Sets the flag to indicate that Orders should be retrieved in ascending sequence.

Parameters:

aByLastUpdate - optional. true indicates that Orders should be retrieved in ascending sequence of their lastUpdate timestamp attribute values.

setStoreId

void setStoreId(java.lang.Integer aStoreId)

Sets the identifier of the Store that owns the pending Orders.

Parameters:

aStoreId - optional. If specified, only Orders owned by the specified Store are retrieved.