com.ibm.commerce.contract.commands
Interface ContractCancelCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand
All Known Implementing Classes:
ContractCancelCmdImpl

public interface ContractCancelCmd
extends ControllerCommand

Cancels the specified contract by changing its contract state to Cancelled (WebSphere Commerce Business Edition only). This command does not remove the contract from the database. A contract can be cancelled any time exception the contract in Draft, DeploymentInProgress, or Closed state.


Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.String defaultCommandClassName
          The name of default implementation class.
static java.lang.String NAME
          The name of this interface.
 
Method Summary
 java.lang.Long getContractId()
          Returns the ID of the canceled contract.
 void setContractId(java.lang.Long contractId)
          Sets the ID of the contract to be cancelled.
 void setDeleteContract(boolean deleteFlag)
          Sets whether the contract should be deleted.
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
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, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of this interface.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The name of default implementation class.
See Also:
Constant Field Values
Method Detail

getContractId

public java.lang.Long getContractId()
Returns the ID of the canceled contract.
Returns:
the ID of the canceled contract

setContractId

public void setContractId(java.lang.Long contractId)
Sets the ID of the contract to be cancelled.
Parameters:
contractId - the id of the contract

setDeleteContract

public void setDeleteContract(boolean deleteFlag)
Sets whether the contract should be deleted.
Parameters:
deleteFlag - true if the contract should be deleted, false otherwise