com.ibm.commerce.requisitionlist.commands

Class RequisitionListDisplayCmdImpl

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

com.ibm.commerce.requisitionlist.commands.RequisitionListBaseCmdImpl

com.ibm.commerce.requisitionlist.commands.RequisitionListDisplayCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, RequisitionListDisplayCmd, Protectable, 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 RequisitionListDisplayCmdImpl
extends RequisitionListBaseCmdImpl
implements RequisitionListDisplayCmd

This is the default implementation of the RequisitionListDisplayCmd controller command.

Input parameters:

Name	Type	Requirement	Description
requisitionListId	Long	optional	The id of the requisition list to be displayed.
status/type(CO)	Char	optional	The status/type(CO) of the requisition list. The valid values are 'Y' and 'Z'/"PRL" and "SRL".
requisitionListStoreId	Long	optional	The store id of the requisition list.

Output parameters:

Name	Type	Description
requisitionListId	Long[]	the resolved requisition list ids

Behavior:

• If the input requisitionListId is specified, it only displays the specified requisition list. The other two parameters status/type(CO) and requisitionListStoreId are ignored. The same requisitionListId will be returned and it forwards to a RequisitionListDetailView view.
• The parameter status/type(CO) defines a set of requisition lists, say S1.
• If status/type(CO) = 'Y', S1 contains all private requisition lists.
• If status/type(CO) = 'Z', S1 contains all shareable requisition lists.
• If status/type(CO) is missing, S1 contains both types of requisition lists.
• The parameter requisitionListStoreId defines a set of requisition lists, say S2.
• If requisitionListStoreId is specified, S2 contains the requisition lists for that store.
• If requisitionListStoreId= *, S2 contains the requisition lists for all stores.
• If requisitionListStoreId is not specified, S2 contains the requisition lists for the current store which is in the command context. If there is no current store in the command context, S2 contains the requisition lists for all stores.
• If the input requisitionListId is missing, it will use the other two parameters status/type(CO) and requisitionListStoreId to return all IDs. These IDs will be in both S1 and S2 and also available to the user. It forwards to a RequisitionListView view.

View:

• If requisitionListId is specified, it sets RequisitionListDetailView.
• If requisitionListId is not specified, it sets RequisitionListView.

This command uses the following AccessBeans:

• OrderAccessBean
• UserAccessBean

See Also:

Serialized Form

Field Summary

Fields

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

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

LOCAL

Fields inherited from interface com.ibm.commerce.requisitionlist.commands.RequisitionListDisplayCmd

ALL_STORE_ID, defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
RequisitionListDisplayCmdImpl()

Method Summary

Modifier and Type	Method and Description
void	checkIsAllowed(AccessVector resource, java.lang.String Paraaction) This method checks for the access control by calling checkIsAllowed() in the super classes
java.lang.String[]	getOutRequisitionListId() This method returns the output requisition list ids.
void	performExecute() This method is the main execution of the command.
void	reset() This method resets all instance variables.
void	setRequestProperties(TypedProperty reqProperties) This method sets the request properties.
void	setRequisitionListId(java.lang.Long id) This method specifies the requisition list id to be displayed.
void	setRequisitionListStoreId(java.lang.String[] id) This method specifies the store id of the requisition list to be displayed.
void	setStatus(java.lang.String status) This method specifies the status of the requisition list to be displayed.
void	setType(java.lang.String type) This method specifies the type of the requisition list to be displayed.
void	validateParameters() This method validates the input parameters.

Methods inherited from class com.ibm.commerce.requisitionlist.commands.RequisitionListBaseCmdImpl

deleteRequisitionListHelper, getStatus, getType, setRequisitionListStatus, setRequisitionListType

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

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

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

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

checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties

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

unionDependencies

Methods inherited from interface com.ibm.commerce.command.AccCommand

accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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

isReadyToCallExecute

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

RequisitionListDisplayCmdImpl

public RequisitionListDisplayCmdImpl()

Method Detail

checkIsAllowed

public void checkIsAllowed(AccessVector resource,
                           java.lang.String Paraaction)
                    throws ECException

This method checks for the access control by calling checkIsAllowed() in the super classes

Parameters:

resource - AccessVector

Paraaction - action

Throws:

ECException

getOutRequisitionListId

public java.lang.String[] getOutRequisitionListId()

This method returns the output requisition list ids.

Returns:

an array of requisition list ids.

performExecute

public void performExecute()
                    throws ECException

This method is the main execution of the command. It calls the following methods:

• action()
• updateResponseView()

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()

This method resets all instance variables.

Specified by:

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

Overrides:

reset in class RequisitionListBaseCmdImpl

setRequestProperties

public void setRequestProperties(TypedProperty reqProperties)
                          throws ECException

This method sets the request properties.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class RequisitionListBaseCmdImpl

Parameters:

reqProperties - request properties.

Throws:

ECException

setRequisitionListId

public void setRequisitionListId(java.lang.Long id)

This method specifies the requisition list id to be displayed.

Specified by:

setRequisitionListId in interface RequisitionListDisplayCmd

Parameters:

id - requisition list id.

setRequisitionListStoreId

public void setRequisitionListStoreId(java.lang.String[] id)

This method specifies the store id of the requisition list to be displayed.

Specified by:

setRequisitionListStoreId in interface RequisitionListDisplayCmd

Parameters:

id - an array of store ids.

setStatus

public void setStatus(java.lang.String status)

This method specifies the status of the requisition list to be displayed.

Specified by:

setStatus in interface RequisitionListDisplayCmd

Parameters:

status - the status of the requisition list to be displayed.

validateParameters

public void validateParameters()
                        throws ECException

This method validates the input parameters.

It checks the validation of the following parameter values:

• status
• requisitionListId

Exception:

• It throws an ECApplicationException with the message key _ERR_INVALID_INPUT, if the input parameter status is not 'Y' or 'Z'.
• It throws an ECApplicationException with the message key _ERR_INVALID_ORDER_REFNUM, if the input parameter requisitionListId is not a valid order id.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException

setType

public void setType(java.lang.String type)

This method specifies the type of the requisition list to be displayed.

Specified by:

setType in interface RequisitionListDisplayCmd

Parameters:

type - the type of the requisition list to be displayed.