com.ibm.commerce.contract.commands
Class ContractImportApprovedVersionCmdImpl

com.ibm.commerce.command.AbstractECTargetableCommand
  |
  +--com.ibm.commerce.command.ControllerCommandImpl
        |
        +--com.ibm.commerce.contract.commands.ContractImportApprovedVersionCmdImpl
All Implemented Interfaces:
AccCommand, ContractImportApprovedVersionCmd, ControllerCommand, ECCommand, ECTargetableCommand, Protectable

public class ContractImportApprovedVersionCmdImpl
extends ControllerCommandImpl
implements ContractImportApprovedVersionCmd

Import a contract from a specified XML file (WebSphere Commerce Business Edition only). The state of the contract in the XML file has to be either Approved or Active.


Field Summary
static java.lang.String CLASSNAME
           
static java.lang.String COPYRIGHT
           
 
Fields inherited from class com.ibm.commerce.command.ControllerCommandImpl
requestProperties, responseProperties, retriable, viewReqProperties
 
Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.contract.commands.ContractImportApprovedVersionCmd
defaultCommandClassName, NAME
 
Constructor Summary
ContractImportApprovedVersionCmdImpl()
           
 
Method Summary
 java.lang.Long getContractId()
          Return contract id
 java.lang.Integer getContractState()
          Return contract state
 java.lang.String getUrl()
          Gets the redirection url to be called when the command completes successfully.
 void importContract(org.w3c.dom.Element contractElement, java.lang.Integer contractState)
          Import a contract based on the contract element
 void importContractNLDesc(org.w3c.dom.Element cntrDescElement)
          Import a contract description based on the contract description element
 boolean isInRightStateToUpdate()
          Check if the contract is in right state for updating action
 boolean isUpdate()
          Return if the action is update.
 void performExecute()
          Contains the actual business logic of the command It should be implemented by all the command writer.
 void setContractId(java.lang.Long newContractId)
          Set the contract id parameter
 void setContractState(java.lang.Integer newContractState)
          Set the contract state parameter
 void setContractXMLFileName(java.lang.String astrContractFileName)
          Set xml file name parameter
 void setCurrentContractState(java.lang.Integer newContractState)
          Set the current contract state parameter
 void setLanguageId(java.lang.Integer newLangId)
          Set the language id parameter
 void setRequestProperties(TypedProperty aRequestProperties)
          The WebController calls this method before invoking the execute method in this command to set the request properties for this command.
 void setStoreId(java.lang.Integer storeId)
          Set store id parameter
 void setUrl(java.lang.String astrUrl)
          Sets the redirection url to be called when the command completes successfully.
 void validateParameters()
          Performs server side parameter checking.
 
Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
 
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setDefaultProperties
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME

COPYRIGHT

public static final java.lang.String COPYRIGHT
Constructor Detail

ContractImportApprovedVersionCmdImpl

public ContractImportApprovedVersionCmdImpl()
Method Detail

getContractId

public java.lang.Long getContractId()
Return contract id
Returns:
java.lang.Long

getContractState

public java.lang.Integer getContractState()
Return contract state
Returns:
java.lang.Integer

getUrl

public java.lang.String getUrl()
Gets the redirection url to be called when the command completes successfully.

importContract

public void importContract(org.w3c.dom.Element contractElement,
                           java.lang.Integer contractState)
                    throws ECException
Import a contract based on the contract element
Parameters:
contractElement - org.w3c.dom.Element
contractState - java.lang.Integer

importContractNLDesc

public void importContractNLDesc(org.w3c.dom.Element cntrDescElement)
                          throws ECException
Import a contract description based on the contract description element
Parameters:
cntrDescElement - org.w3c.dom.Element

isInRightStateToUpdate

public boolean isInRightStateToUpdate()
Check if the contract is in right state for updating action

isUpdate

public boolean isUpdate()
Return if the action is update.

performExecute

public void performExecute()
                    throws ECException
Description copied from interface: ECCommand
Contains the actual business logic of the command It should be implemented by all the command writer.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
com.ibm.commerce.command.CommandException - The superclass for all ECExceptions.

setContractId

public void setContractId(java.lang.Long newContractId)
Set the contract id parameter
Parameters:
contractId - java.lang.Long

setContractState

public void setContractState(java.lang.Integer newContractState)
Set the contract state parameter
Parameters:
newContractState - java.lang.Integer

setContractXMLFileName

public void setContractXMLFileName(java.lang.String astrContractFileName)
Set xml file name parameter
Specified by:
setContractXMLFileName in interface ContractImportApprovedVersionCmd
Parameters:
astrContractFileName - java.lang.String

setCurrentContractState

public void setCurrentContractState(java.lang.Integer newContractState)
Set the current contract state parameter
Parameters:
newContractState - java.lang.Integer

setLanguageId

public void setLanguageId(java.lang.Integer newLangId)
Set the language id parameter
Parameters:
newLangId - java.lang.Integer

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
Description copied from interface: ControllerCommand
The WebController calls this method before invoking the execute method in this command to set the request properties for this command. It is the responsibility of the implementer of the ControllerCommand to extract the required input parameters from the request properties and perform parameter checking.
Specified by:
setRequestProperties in interface ControllerCommand
Overrides:
setRequestProperties in class ControllerCommandImpl
Following copied from interface: com.ibm.commerce.command.ControllerCommand
Parameters:
requestProperties - com.ibm.commerce.datatype.TypedProperty
Throws:
com.ibm.commerce.exception.ECException. -  

setStoreId

public void setStoreId(java.lang.Integer storeId)
Set store id parameter
Specified by:
setStoreId in interface ContractImportApprovedVersionCmd
Parameters:
storeId - java.lang.Integer

setUrl

public void setUrl(java.lang.String astrUrl)
Sets the redirection url to be called when the command completes successfully.
Specified by:
setUrl in interface ContractImportApprovedVersionCmd
Parameters:
astrUrl - java.lang.String - redirection url string

validateParameters

public void validateParameters()
                        throws ECException
Description copied from interface: ECCommand
Performs server side parameter checking. This method replaces the checkParameters() method in a previous version of the code.

Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
ECException. -