com.ibm.commerce.order.commands

Class CheckOrderAttributesCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.TaskCommandImpl

com.ibm.commerce.order.commands.CheckOrderAttributesCmdImpl

All Implemented Interfaces:

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

public class CheckOrderAttributesCmdImpl
extends TaskCommandImpl
implements CheckOrderAttributesCmd

This command check order's attributes.

Behavior

The command does the following:

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.order.commands.CheckOrderAttributesCmd

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
CheckOrderAttributesCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.util.Map	getAttributes() get attributes' names and values
OrderAccessBean	getOrderAccessBean() get order access bean
OrderItemAccessBean[]	getOrderItemAccessBean() get order item access bean
java.util.Map	getOrderItems()
void	performExecute() This is the default implementation of this task command.
void	reset() reset all parameters
void	setAttributes(java.lang.String[] attributeNames, java.lang.String[] attributeValues) set attributes you want to check.
void	setOrderAccessBean(OrderAccessBean orderAB) set order access bean you want to check
void	setOrderItemAccessBean(OrderItemAccessBean[] orderItemABs) set order item access bean you want to check
void	setOrderItems(java.util.Map orderItemIds) set order item id

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

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

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

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

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

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

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, setCommandTarget, setCommandTargetName, setOutputProperties

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

isReadyToCallExecute

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, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

CheckOrderAttributesCmdImpl

public CheckOrderAttributesCmdImpl()

Method Detail

setOrderItems

public void setOrderItems(java.util.Map orderItemIds)

set order item id

Parameters:

orderItemIds -

getOrderItems

public java.util.Map getOrderItems()

Specified by:

getOrderItems in interface CheckOrderAttributesCmd

Returns:

Map with below format The following sample code demonstrates how to resolve the result:

        Map result = checkOrderAttributes.getOrderItems();
        String[] orderItemIds = (String[]) result.get("orderItemIds");
        Map[]    attributes   = (Map[])    result.get("attributeNames");
  for (int i=0; i<orderItemIds.length; i++) {
        String orderItem=orderItemIds[i];
        Map attributesArray = attributes[i];
        if (attributesArray.containsKey("attributeName1")){
                String attributeValue1 = (String) attributesArray.get("attributeName1");
        }
  }
 

setOrderAccessBean

public void setOrderAccessBean(OrderAccessBean orderAB)

set order access bean you want to check

Specified by:

setOrderAccessBean in interface CheckOrderAttributesCmd

Parameters:

orderAB -

getOrderAccessBean

public OrderAccessBean getOrderAccessBean()

get order access bean

Returns:

iOrderAB

setOrderItemAccessBean

public void setOrderItemAccessBean(OrderItemAccessBean[] orderItemABs)

set order item access bean you want to check

Specified by:

setOrderItemAccessBean in interface CheckOrderAttributesCmd

Parameters:

orderItemABs -

getOrderItemAccessBean

public OrderItemAccessBean[] getOrderItemAccessBean()

get order item access bean

Returns:

iOrderItemAB

setAttributes

public void setAttributes(java.lang.String[] attributeNames,
                          java.lang.String[] attributeValues)

set attributes you want to check. If attributeValues is null, return order items which contain any one of attribute names and attributes' values. If attributeValues is not null, return order items which contain attributeNames[i] and the attribute value equal to the value of attributeValues[i]. The following sample code demonstrates how to set attributes:

      String[] attributeNames  = new String[] ({"attributeName1",  "attributeName2" });
      String[] attributeValues = new String[] ({"attributeValue1", "attributeValue2"});
 

attributeValues can be null.

Specified by:

setAttributes in interface CheckOrderAttributesCmd

Parameters:

attributeNames -

attributeValues -

getAttributes

public java.util.Map getAttributes()

get attributes' names and values

Returns:

Map

performExecute

public void performExecute()
                    throws ECException

This is the default implementation of this task command. It checks the specified order. If caller did not specify attributes' values, this task command returns order items list which contains any of attribute name. If caller specified attributes' values, this task command return order items list which the order item contains any attributeNames[i] and the value equal to attributeValues[i].

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException

reset

public void reset()

reset all parameters

Specified by:

reset in interface com.ibm.websphere.command.Command

Overrides:

reset in class AbstractECTargetableCommand