com.ibm.commerce.requisitionlist.commands
Interface RequisitionListDisplayCmd
- All Superinterfaces:
- AccCommand, ControllerCommand, ECCommand, Protectable
- All Known Implementing Classes:
- RequisitionListDisplayCmdImpl
- public interface RequisitionListDisplayCmd
- extends ControllerCommand
Display one or more requisition lists.
Input parameters:
Name | Type | Requirement | Description |
requisitionListId | Long | optional | The id of the requisition list to be displayed. |
status | Char | optional | The status of the requisition list.
The valid values are 'Y' and 'Z'. |
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 and requisitionListStoreId
are ignored. The same requisitionListId will be returned and it forwards to
a RequisitionListDetailView view.
- The parameter status defines a set of requisition lists, say S1.
- If status = 'Y', S1 contains all private requisition lists.
- If status = 'Z', S1 contains all shareable requisition lists.
- If status 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 and requisitionListStoreId to return all IDs of the
requisition lists which are 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.
Method Summary |
void |
setRequisitionListId(java.lang.Long id)
Specifies the requisition list id to be displayed. |
void |
setRequisitionListStoreId(java.lang.String[] id)
Specifies the store id of the requisition list to be displayed. |
void |
setStatus(java.lang.String status)
Specifies the status of the requisition list to be displayed. |
Methods inherited from interface com.ibm.commerce.command.ControllerCommand |
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
ALL_STORE_ID
public static final java.lang.String ALL_STORE_ID
COPYRIGHT
public static final java.lang.String COPYRIGHT
defaultCommandClassName
public static final java.lang.String defaultCommandClassName
NAME
public static final java.lang.String NAME
setRequisitionListId
public void setRequisitionListId(java.lang.Long id)
- Specifies the requisition list id to be displayed.
setRequisitionListStoreId
public void setRequisitionListStoreId(java.lang.String[] id)
- Specifies the store id of the requisition list to be displayed.
setStatus
public void setStatus(java.lang.String status)
- Specifies the status of the requisition list to be displayed.