NotifyBlockCmd

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

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

All Known Implementing Classes:

NotifyBlockCmdImpl
```
public interface NotifyBlockCmd
extends TaskCommand
```
This Order task command is used to perform a block or unblock operation for a specified order ID and block reason code ID. This command will be invoked by the BlockNotifyCmd controller command. The default implementation of this command is NotifyBlockCmdImpl.

See Also:

BlockNotifyCmd

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` The IBM copyright notice field.
`static java.lang.String`	`defaultCommandClassName` The name of the default implementation class for this command interface.
`static java.lang.String`	`NAME` The name of this command interface.

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.Long`	`getTicklerId()` This method returns the ticklerId for any block that was set
`void`	`setBlockNotify(java.lang.String blockNotify)` Sting value which indicates if to block (true) or unblock (false)
`void`	`setBlockReasonCodeId(java.lang.String blockRsnCodeId)` The block reason code ID for the block or unblock operation
`void`	`setComments(java.lang.String comments)` Comments that may have been passed along with the block or unblock operation
`void`	`setOrderId(java.lang.String orderId)` This method sets the order ID to perform the blocking on

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

Methods inherited from interface com.ibm.websphere.command.Command
isReadyToCallExecute, reset

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

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    The IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
  - NAME
```
static final java.lang.String NAME
```
    The name of this command interface.
    
    See Also:
    
    Constant Field Values
  - defaultCommandClassName
```
static final java.lang.String defaultCommandClassName
```
    The name of the default implementation class for this command interface.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setOrderId
```
void setOrderId(java.lang.String orderId)
```
    This method sets the order ID to perform the blocking on
    
    Parameters:
    
    orderId -
  - setBlockNotify
```
void setBlockNotify(java.lang.String blockNotify)
```
    Sting value which indicates if to block (true) or unblock (false)
    
    Parameters:
    
    blockNotify -
  - setBlockReasonCodeId
```
void setBlockReasonCodeId(java.lang.String blockRsnCodeId)
```
    The block reason code ID for the block or unblock operation
    
    Parameters:
    
    blockRsnCodeId -
  - setComments
```
void setComments(java.lang.String comments)
```
    Comments that may have been passed along with the block or unblock operation
    
    Parameters:
    
    comments -
  - getTicklerId
```
java.lang.Long getTicklerId()
```
    This method returns the ticklerId for any block that was set
    
    Returns:
    
    ticklerId