com.ibm.commerce.order.utils

Interface ResolveOrderQuotationRelsCmd

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:

ResolveOrderQuotationRelsCmdImpl

public interface ResolveOrderQuotationRelsCmd
extends TaskCommand

This task command is responsible for resolving OrderQuotationRel abbreviations into OrderQuotationRelAccessBeans.

Abbreviation Value	Meaning
*n	No OrderQuotationRel objects.
*initial	All OrderQuotationRel objects whose relType attribute indicates initial.
*selection	All OrderQuotationRel objects whose relType attribute indicates selection.
*final	All OrderQuotationRel objects whose relType attribute indicates final.
*submission	All OrderQuotationRel objects whose relType attribute indicates submission.
*parent<(OrderId | Order abbreviation)>	All OrderQuotationRel objects whose parentId attribute indicates one of the Orders indicated by <(OrderId | Order abbreviation)>.
*child<(OrderId | Order abbreviation)>	All OrderQuotationRel objects whose childId attribute indicates one of the Orders indicated by <(OrderId | Order abbreviation)>.
*store<(StoreId)>	All OrderQuotationRel objects whose childStoreId attribute indicates one of the Stores indicated by <(StoreId)>.
*contract<(ContractId | *default)>	All OrderQuotationRel objects whose tradingAgreementId attribute indicates one of the Contracts indicated by <(ContractId | *default)>, where *default indicates the default Contract for the Store indicated by the childStoreId attribute of the OrderQuotationRel object.
any combination of the above abbreviation values	OrderQuotationRel abbreviations may be concatenated to represent the intersection of the sets of OrderQuotationsRel objects represented by the individual abbreviations.

Example Abbreviation Value	Meaning
*initial*parent.	All OrderQuotationRel objects whose parent Order is one of the current pending Orders (for the current user in the current Store). And the objects whose relType attribute indicates initial.
*contract*default*store123*final	All OrderQuotationRel objects whose storeId attribute is 123 and whose tradingAgreementId attribute indicates the default Contract for that Store and whose relType attribute indicates final.
*store123*parent*	All OrderQuotationRel objects whose storeId attribute is 123 and whose parent Order is a pending Order (of the current user in the current Store).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM copyright string.
static java.lang.String	defaultCommandClassName The default implementation of this command.
static java.lang.String	NAME The name of this command.
static java.lang.String	TOKEN_CHILD All OrderQuotationRel objects whose childId attribute indicates one of the Orders indicated by the OrderId/Order abbreviation that follows.
static java.lang.String	TOKEN_CONTRACT All OrderQuotationRel objects whose tradingAgreementId attribute indicates one of the Contracts indicated by the ContractId that follows.
static java.lang.String	TOKEN_DEFAULT Indicates the default Contract for the Store indicated by the childStoreId attribute of the OrderQuotationRel object.
static java.lang.String	TOKEN_FINAL All OrderQuotationRel objects whose relType attribute indicates final.
static java.lang.String	TOKEN_INITIAL All OrderQuotationRel objects whose relType attribute indicates initial.
static java.lang.String	TOKEN_NONE No OrderQuotationRel objects.
static java.lang.String	TOKEN_PARENT All OrderQuotationRel objects whose parentId attribute indicates one of the Orders indicated by the OrderId/Order abbreviation that follows.
static java.lang.String	TOKEN_SELECTION All OrderQuotationRel objects whose relType attribute indicates selection.
static java.lang.String	TOKEN_STORE All OrderQuotationRel objects whose childStoreId attribute indicates one of the Stores indicated by the StoreId that follows.
static java.lang.String	TOKEN_SUBMISSION All OrderQuotationRel objects whose relType attribute indicates submission.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
com.ibm.commerce.order.objects.OrderQuotationRelAccessBean[]	getOrderQuotationRels() Returns the OrderQuotationRelAccessBeans represented by the abbreviations.
int	getParsingPosition() Returns the character position in the abbreviation where parsing has ended.
void	setIncompleteParsingAllowed(boolean abIncompleteParsingAllowed) Sets whether incomplete parsing is allowed.
void	setInitialParsingPosition(int anInitialParsingPosition) Sets the character position in the abbreviation where parsing should start.
void	setOrderQuotationRelAbbreviations(java.lang.String[] astrOrderQuotationRelAbbreviations) Sets the OrderQuotationRel abbreviations to be resolved.

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 string.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The 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

TOKEN_NONE

static final java.lang.String TOKEN_NONE

No OrderQuotationRel objects.

See Also:

Constant Field Values

TOKEN_INITIAL

static final java.lang.String TOKEN_INITIAL

All OrderQuotationRel objects whose relType attribute indicates initial.

See Also:

Constant Field Values

TOKEN_SELECTION

static final java.lang.String TOKEN_SELECTION

All OrderQuotationRel objects whose relType attribute indicates selection.

See Also:

Constant Field Values

TOKEN_FINAL

static final java.lang.String TOKEN_FINAL

All OrderQuotationRel objects whose relType attribute indicates final.

See Also:

Constant Field Values

TOKEN_SUBMISSION

static final java.lang.String TOKEN_SUBMISSION

All OrderQuotationRel objects whose relType attribute indicates submission.

See Also:

Constant Field Values

TOKEN_PARENT

static final java.lang.String TOKEN_PARENT

All OrderQuotationRel objects whose parentId attribute indicates one of the Orders indicated by the OrderId/Order abbreviation that follows.

See Also:

Constant Field Values

TOKEN_CHILD

static final java.lang.String TOKEN_CHILD

All OrderQuotationRel objects whose childId attribute indicates one of the Orders indicated by the OrderId/Order abbreviation that follows.

See Also:

Constant Field Values

TOKEN_STORE

static final java.lang.String TOKEN_STORE

All OrderQuotationRel objects whose childStoreId attribute indicates one of the Stores indicated by the StoreId that follows.

See Also:

Constant Field Values

TOKEN_CONTRACT

static final java.lang.String TOKEN_CONTRACT

All OrderQuotationRel objects whose tradingAgreementId attribute indicates one of the Contracts indicated by the ContractId that follows.

See Also:

Constant Field Values

TOKEN_DEFAULT

static final java.lang.String TOKEN_DEFAULT

Indicates the default Contract for the Store indicated by the childStoreId attribute of the OrderQuotationRel object.

See Also:

Constant Field Values

Method Detail

setOrderQuotationRelAbbreviations

void setOrderQuotationRelAbbreviations(java.lang.String[] astrOrderQuotationRelAbbreviations)

Sets the OrderQuotationRel abbreviations to be resolved.

Parameters:

astrOrderQuotationRelAbbreviations - the OrderQuotationRel abbreviations.

setIncompleteParsingAllowed

void setIncompleteParsingAllowed(boolean abIncompleteParsingAllowed)

Sets whether incomplete parsing is allowed. If false, an _ERR_ORDQUOTREL ECApplicationException will be thrown if the abbreviation cannot be completely parsed.

Parameters:

abIncompleteParsingAllowed - whether incomplete parsing is allowed. Default is false.

setInitialParsingPosition

void setInitialParsingPosition(int anInitialParsingPosition)

Sets the character position in the abbreviation where parsing should start.

Parameters:

anInitialParsingPosition - the initial parsing position. Default is 0.

getOrderQuotationRels

com.ibm.commerce.order.objects.OrderQuotationRelAccessBean[] getOrderQuotationRels()

Returns the OrderQuotationRelAccessBeans represented by the abbreviations.

Returns:

the OrderQuotationRelAccessBeans.

getParsingPosition

int getParsingPosition()

Returns the character position in the abbreviation where parsing has ended.

Returns:

the parsing position.