com.ibm.commerce.order.utils
Interface ResolveOrdersCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
ResolveOrdersCmdImpl

public interface ResolveOrdersCmd
extends TaskCommand

This task command is called by other Order commands to resolve order abbreviations (e.g. '*').


Field Summary
static java.lang.String ALL_ORDER_TEMPLATES
          Parameter for all order templates
static java.lang.String ALL_PENDING_ORDERS
          Parameter for all pending orders
static java.lang.String COPYRIGHT
          IBM copyright statement
static java.lang.String CURRENT_NEW_CURRENT
          Parameter for current and new orders
static java.lang.String CURRENT_ORDER_TEMPLATES
          Parameter for the current order templates
static java.lang.String CURRENT_PENDING_ORDERS
          Parameter for current and pending orders
static java.lang.String defaultCommandClassName
          The implementation of this command
static java.lang.String EC_TOKEN_CHILD
          Parameter for teh child token
static java.lang.String EC_TOKEN_PARENT
          Parameter for the parent token
static java.lang.String NAME
          This command
static java.lang.String NEW_PENDING_ORDER
          Parameter for new and pending orders
static java.lang.String NO_ORDER
          Paramater for no orders
static java.lang.String PROFILE
          Parameter for profile
 
Method Summary
 java.lang.Long[] getOrderIds()
          Gets the order ids
  OrderAccessBean[] getOrders()
          Gets the orders
 int getParsingPosition()
          Gets the parsing position
 java.util.Set getUnprocessedAbbreviations()
          Gets the unprocessed abbreviations
 boolean isNewPendingOrder()
          Deprecated.  
 boolean isSetToCurrent()
          Deprecated.  
 void setAllowedAbbreviations(java.util.Set asetAllowedAbbreviations)
          Sets the allowed abbreviations
 void setDisallowedAbbreviations(java.util.Set asetDisallowedAbbreviations)
          Sets the abbreviations that are not allowed
 void setForeignOrdersAllowed(boolean abForeignOrdersAllowed)
          Sets if foreign orders are allowed
 void setIncompleteParsingAllowed(boolean abIncompleteParsingAllowed)
          Sets if incomplete parsing is allowed
 void setInitialParsingPosition(int anInitialParsingPosition)
          Sets the initial paring position
 void setMemberId(java.lang.Long anMemberId)
          Sets the member ID
 void setOrderAbbreviations(java.lang.String[] astrOrderAbbreviations)
          Sets the order abbreviations
 void setStoreId(java.lang.Integer anStoreId)
          Sets the store ID
 void setStrict(boolean strict)
          Deprecated.  
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright statement
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
This command
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The implementation of this command
See Also:
Constant Field Values

NO_ORDER

public static final java.lang.String NO_ORDER
Paramater for no orders
See Also:
Constant Field Values

ALL_ORDER_TEMPLATES

public static final java.lang.String ALL_ORDER_TEMPLATES
Parameter for all order templates
See Also:
Constant Field Values

ALL_PENDING_ORDERS

public static final java.lang.String ALL_PENDING_ORDERS
Parameter for all pending orders
See Also:
Constant Field Values

CURRENT_NEW_CURRENT

public static final java.lang.String CURRENT_NEW_CURRENT
Parameter for current and new orders
See Also:
Constant Field Values

CURRENT_ORDER_TEMPLATES

public static final java.lang.String CURRENT_ORDER_TEMPLATES
Parameter for the current order templates
See Also:
Constant Field Values

CURRENT_PENDING_ORDERS

public static final java.lang.String CURRENT_PENDING_ORDERS
Parameter for current and pending orders
See Also:
Constant Field Values

NEW_PENDING_ORDER

public static final java.lang.String NEW_PENDING_ORDER
Parameter for new and pending orders
See Also:
Constant Field Values

PROFILE

public static final java.lang.String PROFILE
Parameter for profile
See Also:
Constant Field Values

EC_TOKEN_PARENT

public static final java.lang.String EC_TOKEN_PARENT
Parameter for the parent token
See Also:
Constant Field Values

EC_TOKEN_CHILD

public static final java.lang.String EC_TOKEN_CHILD
Parameter for teh child token
See Also:
Constant Field Values
Method Detail

getOrderIds

public java.lang.Long[] getOrderIds()
Gets the order ids
Returns:
An array of the order ids.

getOrders

public OrderAccessBean[] getOrders()
Gets the orders
Returns:
An array of the Orders

isNewPendingOrder

public boolean isNewPendingOrder()
Deprecated.  
equivalent to (getUnprocessedAbbreviations() != null && getUnprocessedAbbreviations().contains(ResolveOrdersCmd.NEW_PENDING_ORDER))
Returns:
true if order is new pending, false otherwise

isSetToCurrent

public boolean isSetToCurrent()
Deprecated.  
equivalent to (getUnprocessedAbbreviations() != null && getUnprocessedAbbreviations().contains(ResolveOrdersCmd.CURRENT_NEW_CURRENT))
Returns:
true if current, false otherwiser

setMemberId

public void setMemberId(java.lang.Long anMemberId)
Sets the member ID
Parameters:
anMemberId - the member id

setOrderAbbreviations

public void setOrderAbbreviations(java.lang.String[] astrOrderAbbreviations)
Sets the order abbreviations
Parameters:
astrOrderAbbreviations - a String array of order abbreviations.

setStoreId

public void setStoreId(java.lang.Integer anStoreId)
Sets the store ID
Parameters:
anStoreId - the store ID

setStrict

public void setStrict(boolean strict)
Deprecated.  
equivalent to setForeignOrdersAllowed(!strict)
Parameters:
strict - - false if foreign orders are allowed, true otherwise

setForeignOrdersAllowed

public void setForeignOrdersAllowed(boolean abForeignOrdersAllowed)
Sets if foreign orders are allowed

setAllowedAbbreviations

public void setAllowedAbbreviations(java.util.Set asetAllowedAbbreviations)
Sets the allowed abbreviations
Parameters:
asetAllowedAbbreviations - a Set of the allowed abbreviations

setDisallowedAbbreviations

public void setDisallowedAbbreviations(java.util.Set asetDisallowedAbbreviations)
Sets the abbreviations that are not allowed
Parameters:
asetDisallowedAbbreviations - a Set of the disallowed abbreviations

getUnprocessedAbbreviations

public java.util.Set getUnprocessedAbbreviations()
Gets the unprocessed abbreviations
Returns:
The unprocessed abbreviations

setIncompleteParsingAllowed

public void setIncompleteParsingAllowed(boolean abIncompleteParsingAllowed)
Sets if incomplete parsing is allowed

setInitialParsingPosition

public void setInitialParsingPosition(int anInitialParsingPosition)
Sets the initial paring position

getParsingPosition

public int getParsingPosition()
Gets the parsing position
Returns:
The parsing position