com.ibm.commerce.contract.commands

Class ImportDTDContractApprovedVersionCmdImpl

java.lang.Object

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.TaskCommandImpl

com.ibm.commerce.contract.commands.ImportDTDContractApprovedVersionCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.ECTargetableCommand, com.ibm.commerce.command.TaskCommand, ImportDTDContractApprovedVersionCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command

public class ImportDTDContractApprovedVersionCmdImpl
extends com.ibm.commerce.command.TaskCommandImpl
implements ImportDTDContractApprovedVersionCmd

This is the default implementation of the ImportDTDContractApprovedVersionCmd task command.

Behaviour:

Imports an approved contract from a specified XML file (WebSphere Commerce Enterprise only). The state of the contract in the XML file has to be either Approved or Active. Calling commands: ContractImportApprovedVersionCmd.

Task commands called:

• CreateContractCmd
• ValidateContractCmd
• ContractDeployCmd
• AddContractNLDescriptionCmd

AccessBeans called:

• ContractAccessBean
• AccountAccessBean
• UserAccessBean
• OrganizationAccessBean
• MemberGroupAccessBean

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Fields inherited from interface com.ibm.commerce.contract.commands.ImportDTDContractApprovedVersionCmd

defaultCommandClassName

Constructor Summary

Constructors

Constructor and Description
ImportDTDContractApprovedVersionCmdImpl()

Method Summary

Modifier and Type	Method and Description
com.ibm.commerce.datatype.TypedProperty	getResponseProperties() Returns the response properties
void	performExecute() Executes the business logic of this command implementation.
void	setContractXML(java.io.InputStream contractXML) Sets the contract xml instance.
void	setContractXMLFileName(java.lang.String astrContractFileName) Sets the contract XML file name.
void	setIbXSDValidation(boolean ibXSDValidation) Set the value of xsd validation, default is true.
void	setStoreId(java.lang.Integer storeId) Sets the target store ID.
void	setSynchronousDeployment(boolean synchronousDeploymentFlag) Sets the synchronousDeployment flag to indicate contract should be deployed synchronously.
void	setUrl(java.lang.String astrUrl) Sets the redirection URL to be called when the command completes successfully.
void	setXMLEntityPath(java.lang.String path) Sets the XML entity path.
void	validateParameters() This is where parameter checking is done.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

ImportDTDContractApprovedVersionCmdImpl

public ImportDTDContractApprovedVersionCmdImpl()

Method Detail

getResponseProperties

public com.ibm.commerce.datatype.TypedProperty getResponseProperties()

Returns the response properties

Specified by:

getResponseProperties in interface ImportDTDContractApprovedVersionCmd

Returns:

responseProperties the responseProperties

performExecute

public void performExecute()
                    throws com.ibm.commerce.exception.ECException

Executes the business logic of this command implementation.

Specified by:

performExecute in interface com.ibm.commerce.command.ECCommand

Overrides:

performExecute in class com.ibm.commerce.command.AbstractECTargetableCommand

Throws:

com.ibm.commerce.exception.ECException

See Also:

importContract(Element, Integer), importContractNLDesc(Element), AbstractECTargetableCommand.performExecute()

setContractXML

public void setContractXML(java.io.InputStream contractXML)

Sets the contract xml instance.

Specified by:

setContractXML in interface ImportDTDContractApprovedVersionCmd

Parameters:

contractXML - an InputStream object contains the contract xml instance

setContractXMLFileName

public void setContractXMLFileName(java.lang.String astrContractFileName)

Sets the contract XML file name.

Specified by:

setContractXMLFileName in interface ImportDTDContractApprovedVersionCmd

Parameters:

astrContractFileName - the name of the contract XML file

setIbXSDValidation

public void setIbXSDValidation(boolean ibXSDValidation)

Set the value of xsd validation, default is true.

Specified by:

setIbXSDValidation in interface ImportDTDContractApprovedVersionCmd

Parameters:

ibXSDValidation -

setStoreId

public void setStoreId(java.lang.Integer storeId)

Sets the target store ID.

Specified by:

setStoreId in interface ImportDTDContractApprovedVersionCmd

Parameters:

storeId - the store ID which the contract will deployed to

setSynchronousDeployment

public void setSynchronousDeployment(boolean synchronousDeploymentFlag)

Sets the synchronousDeployment flag to indicate contract should be deployed synchronously.

Specified by:

setSynchronousDeployment in interface ImportDTDContractApprovedVersionCmd

Parameters:

synchronousDeploymentFlag - true for synchronous deployment, false for asynchronous deployment

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 ImportDTDContractApprovedVersionCmd

Parameters:

astrUrl - the redirect URL string

setXMLEntityPath

public void setXMLEntityPath(java.lang.String path)

Sets the XML entity path.

Specified by:

setXMLEntityPath in interface ImportDTDContractApprovedVersionCmd

Parameters:

path - the path where it can find the DTD or XML Schema file(s)

validateParameters

public void validateParameters()
                        throws com.ibm.commerce.exception.ECException

This is where parameter checking is done. This method does the following checks 1. if the file and the DTD file can be found 2. if the XML file is valid (if the validation is set to true) 3. if the contract is in right state for this command. The contract should be either in Approved or Active state

Specified by:

validateParameters in interface com.ibm.commerce.command.ECCommand

Overrides:

validateParameters in class com.ibm.commerce.command.AbstractECTargetableCommand

Throws:

com.ibm.commerce.exception.ECException - Raised with message _ERR_MISSING_CMD_PARAMETER if the targetStoreId parameter was missing from the url for an Active contract. Raised with message _ERR_FILE_NOT_FOUND if the XML file or DTD file cannot be found. Raised with message _ERR_PARSE_XML_FILE if an error occurred when the XML parser parses the XML file. Raised with message _ERR_GENRIC_PARSE_XML_FILE if an IO error occurred. Raised with message _ERR_WRONG_CONTRACT_STATE if the contract is not in Approved or Active state. Raised with message _ERR_VERSION_NUMBER_FORMAT if the contract version number format is incorrect. It should be numerical. Raised with message _ERR_MISSING_CONTRACT_NAME if the contract name is empty string in the XML file. Raised with message _ERR_WRONG_ACCOUNT_OWNER_INFO if an error occurred when retrieving the account owner id. Raised with message _ERR_ACCOUNT_DOES_NOT_EXIST if an error occurred when retrieving the account based the account name and account owner id. Raised with message _ERR_WRONG_CONTRACT_OWNER_MEMBER_INFO if an error occurred when retrieving the contract owner id. Raised with message _ERR_DUPLICATED_CONTRACT_NAME if there is a contract existed with the same name, owner, and origin. Raised with message _ERR_CONTRACT_REFERENCE_NUMBER_NOT_REQUIRED if the contract referenceNumber attribute is provided in the XML file for Contract element.

See Also:

AbstractECTargetableCommand.validateParameters()