atg.commerce.csr.returns
Class ReturnableStates

java.lang.Object
  atg.commerce.csr.returns.ReturnableStates

public class ReturnableStates
extends java.lang.Object

Defines the states for CommerceItems and Orders that reflect if they can be returned.

There is only one state that is considered "returnable". All other states are "non-returnable" states.

These states are returned by API in ReturnTools. See ReturnTools To add additional "non-returnable" states, that API should be extended to return them.

This class also provides resourced values for each state. To add a new state, a new resourced value should also be added.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	ITEM_ALREADY_RETURNED Generic state to indicate the item is not returnable.
static java.lang.String	ITEM_NON_RETURNABLE State to indicate the item's product or sku has its non-returnable flag set to true.
static java.lang.String	ITEM_NOT_RETURNABLE Generic state to indicate the item is not returnable.
static java.lang.String	ITEM_RETURNABLE Generic state to indicate the item is returnable.
static java.lang.String	ORDER_NO_ITEMS_RETURNABLE Generic state to indicate the order is not returnable because there are no items in it that are returnable.
static java.lang.String	ORDER_NOT_FULFILLED Generic state to indicate the order is not returnable because it hasn't been completely fulfilled.
static java.lang.String	ORDER_NOT_RETURNABLE Generic state to indicate the order is not returnable.
static java.lang.String	ORDER_RETURNABLE Generic state to indicate the order is returnable.
protected static java.lang.String	sResourceFileName

Constructor Summary

ReturnableStates()

Method Summary

static java.lang.String

getStateDescription(java.lang.String pState, java.util.Locale pLocale)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

sResourceFileName

protected static java.lang.String sResourceFileName

ITEM_RETURNABLE

public static final java.lang.String ITEM_RETURNABLE

Generic state to indicate the item is returnable. This is the only state the means an item is returnable. See ReturnTools.getItemReturnableState(RepositoryItem)

See Also:

Constant Field Values

ITEM_ALREADY_RETURNED

public static final java.lang.String ITEM_ALREADY_RETURNED

Generic state to indicate the item is not returnable. See ReturnTools.getItemReturnableState(RepositoryItem)

See Also:

Constant Field Values

ITEM_NOT_RETURNABLE

public static final java.lang.String ITEM_NOT_RETURNABLE

Generic state to indicate the item is not returnable. See ReturnTools.getItemReturnableState(RepositoryItem)

See Also:

Constant Field Values

ITEM_NON_RETURNABLE

public static final java.lang.String ITEM_NON_RETURNABLE

State to indicate the item's product or sku has its non-returnable flag set to true. See ReturnTools.getItemReturnableState(RepositoryItem)

See Also:

Constant Field Values

ORDER_RETURNABLE

public static final java.lang.String ORDER_RETURNABLE

Generic state to indicate the order is returnable. This is the only state the means an order is returnable. See ReturnTools.getOrderReturnableState(RepositoryItem)

See Also:

Constant Field Values

ORDER_NOT_FULFILLED

public static final java.lang.String ORDER_NOT_FULFILLED

Generic state to indicate the order is not returnable because it hasn't been completely fulfilled. See ReturnTools.getOrderReturnableState(RepositoryItem)

See Also:

Constant Field Values

ORDER_NO_ITEMS_RETURNABLE

public static final java.lang.String ORDER_NO_ITEMS_RETURNABLE

Generic state to indicate the order is not returnable because there are no items in it that are returnable. See ReturnTools.getOrderReturnableState(RepositoryItem)

See Also:

Constant Field Values

ORDER_NOT_RETURNABLE

public static final java.lang.String ORDER_NOT_RETURNABLE

Generic state to indicate the order is not returnable. See ReturnTools.getOrderReturnableState(RepositoryItem)

See Also:

Constant Field Values

Constructor Detail

ReturnableStates

public ReturnableStates()

Method Detail

getStateDescription

public static java.lang.String getStateDescription(java.lang.String pState,
                                                   java.util.Locale pLocale)