com.ibm.commerce.contract.commands
Class ContractSaveCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.ControllerCommandImpl
                    |
                    +--com.ibm.commerce.contract.commands.TradingAgreementImportBaseCmdImpl
                          |
                          +--com.ibm.commerce.contract.commands.ContractSaveCmdImpl
All Implemented Interfaces:
AccCommand, ContractSaveCmd, ControllerCommand, ECCommand, ECTargetableCommand

public class ContractSaveCmdImpl
extends TradingAgreementImportBaseCmdImpl
implements ContractSaveCmd

Add a new contract or update an existing one which is in Draft state (WebSphere Commerce Business Edition only). This command will call one of the following TaskCommand: CreateXSDContractCmd, UpdateXSDContractCmd If it updates an existing contract, the UpdateXSDContractCmd will be called. If it adds a new contract, the CreateXSDContractCmd command will be called. The following AccessBean are used in this default implementation: ContractAccessBean, AccountAccessBean, ParticipantAccessBean.

See Also:
CreateXSDContractCmdImpl, UpdateXSDContractCmdImpl., Serialized Form

Field Summary
static java.lang.String CLASSNAME
          The name of this class
static java.lang.String COPYRIGHT
          IBM copyright notice field.
 
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. ContractSaveCmd
defaultCommandClassName, NAME
 
Constructor Summary
ContractSaveCmdImpl()
           
 
Method Summary
 java.lang.Integer getContractState()
          Returns the contract state.
  TypedProperty getViewInputProperties()
          This method is called by the web controller to retrieve the request properties set by the setRequestProperties() method.
 boolean isInRightStateToUpdate()
          Checks if the contract is in right state for updating action.
 boolean isUpdate()
          Returns if the action of this command based on the information inside the xml string.
 void performExecute()
          Saves the contract.
 void setContractId(java.lang.Long contractId)
          Sets the contract id parameter.
 void setContractState(java.lang.Integer contractState)
          Sets the contract state parameter.
 void setCurrentContractState(java.lang.Integer curContractState)
          Sets the current contract state parameter.
 void setLanguageId(java.lang.Integer langId)
          Sets the language id parameter.
 void setLastUpdatedTime(java.lang.String lastUpdatedTime)
          Sets the last update time of the contract.
 void setRequestProperties( TypedProperty aRequestProperties)
          Retrieves input parameters from the request properties.
 void setXML(java.lang.String xmlString)
          Sets the input xml string.
 void setXSDValidation(boolean bValidation)
          Sets the XSD validation flag.
 void validateParameters()
          The method checks if the information provided in contract Element object is valid.
 
Methods inherited from class com.ibm.commerce.contract.commands. TradingAgreementImportBaseCmdImpl
getAccountId, getContractId, getDOMFromFile, getDOMFromInputStream, getElementsByTag, getXMLFlag, importContractNLDesc, importFfcNLDesc, importStoreNLDesc, saveAccount, saveContract, setXSDFlag
 
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
 
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 
Methods inherited from class java.lang.Object
clone, 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, isGeneric, isRetriable, mergeProperties, setGeneric, 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, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 

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

CLASSNAME

public static final java.lang.String CLASSNAME
The name of this class
See Also:
Constant Field Values
Constructor Detail

ContractSaveCmdImpl

public ContractSaveCmdImpl()
Method Detail

getContractState

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

getViewInputProperties

public TypedProperty getViewInputProperties()
This method is called by the web controller to retrieve the request properties set by the setRequestProperties() method. The tools need to override this method because otherwise the properties passed into the controller command would be then passed onto the view command. This is unnecessary for the tools and actually will break us when using the ReDirectView comman because the URL to re-direct to cannot be more than 500 chars. The XML parameter alone passed into the controller command is longer than this and therefore without overriding this method we couldn't re-direct to the view command.
Specified by:
getViewInputProperties in interface ControllerCommand
Overrides:
getViewInputProperties in class ControllerCommandImpl
Returns:
com.ibm.commerce.datatype.TypeProperty

isInRightStateToUpdate

public boolean isInRightStateToUpdate()
Checks if the contract is in right state for updating action.
Returns:
a boolean value. true: the contract is in right state to update. false: the contract is not in right state.

isUpdate

public boolean isUpdate()
Returns if the action of this command based on the information inside the xml string.
Returns:
a boolean value represents the action of the command. true: create; false: update

performExecute

public void performExecute()
                    throws ECException
Saves the contract.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException - Raised with message _ERR_CONTRACT_SAVE when an error occurred.
See Also:
CreateXSDContractCmdImpl.performExecute(), UpdateXSDContractCmdImpl.performExecute(), AbstratECTargetableCommand#performExecute()

setContractId

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

setContractState

public void setContractState(java.lang.Integer contractState)
Sets the contract state parameter.
Parameters:
contractState - the state of the contract

setCurrentContractState

public void setCurrentContractState(java.lang.Integer curContractState)
Sets the current contract state parameter.
Parameters:
curContractState - the current state of the contract

setLanguageId

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

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
Retrieves input parameters from the request properties.
Specified by:
setRequestProperties in interface ControllerCommand
Overrides:
setRequestProperties in class ControllerCommandImpl
Parameters:
aRequestProperties - An TypedProperty object contains the input parameters.
Throws:
ECApplicationException - Raised with message _ERR_MISSING_CMD_PARAMETER when the input xml string is missed.

setLastUpdatedTime

public void setLastUpdatedTime(java.lang.String lastUpdatedTime)
Sets the last update time of the contract.
Specified by:
setLastUpdatedTime in interface ContractSaveCmd
Parameters:
lastUpdatedTime - the last update time string

setXML

public void setXML(java.lang.String xmlString)
Sets the input xml string.
Specified by:
setXML in interface ContractSaveCmd
Parameters:
xmlString - the input xml string.

setXSDValidation

public void setXSDValidation(boolean bValidation)
Sets the XSD validation flag. If the flag is set to true, the xml parser will validate the xml instance against the specified XSD file.
Specified by:
setXSDValidation in interface ContractSaveCmd
Parameters:
bValidation - the validation flag, true: validate, false: do not validate.

validateParameters

public void validateParameters()
                        throws ECException
The method checks if the information provided in contract Element object is valid.
Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECException - Raised with message _ERR_WRONG_CONTRACT_STATE if the state of the contract is not in Draft state. Raised with message _ERR_WRONG_ACCOUNT_OWNER_INFO when the member id cannot be found based on the specified account owner, if the contract refers to an account. Raised with message _ERR_ACCOUNT_DOES_NOT_EXIST when the account cannot be found based the provided account name and owner information, if the contract refers to an account. Raised with message EC_ERR_NO_AUTH_REF_ANOTHER_TRADING if the referred to contract is not a Referral or Hosting contract, or the contract owner is not as a Referral/Reseller participant in the referred Referral/Hosting contract. Raised with message _ERR_DUPLICATED_CONTRACT_NAME if there is an existing contract with the same name, origin, and state in the database and the action is created. Raised with message _ERR_WRONG_CONTRACT_OWNER_MEMBER_INFO if the contract owner id cannot be retrived based on the contract owner information specified in the xml string.
See Also:
AbstratECTargetableCommand#validateParameters()