public class ContractImportDraftVersionCmdImpl extends TradingAgreementImportBaseCmdImpl implements ContractImportDraftVersionCmd
ContractImportDraftVersionCmd
controller command.
Name | Description |
---|---|
fileName |
The file name of the importing XML file. It is mandatory. |
URL |
The url parameter. It is mandatory. |
path |
The XML entity path. It is mandatory. |
xsd |
The flag indicates if a XML instance file is based on XSD or not. It is optional. |
validate |
The flag indicates if validating an importing XML file against a XML schema. It is optional. |
CreateXSDContractCmd
ImportDTDContractApprovedVersionCmd
AddContractNLDescriptionCmd
AddStoreNLDescriptionCmd
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASSNAME
The full name of this class.
|
static java.lang.String |
COPYRIGHT
The IBM copyright notice field.
|
defaultCommandClassName, NAME
Constructor and Description |
---|
ContractImportDraftVersionCmdImpl() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getUrl()
Gets the redirection URL to be called when the command completes successfully.
|
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 contractFileName)
Sets the contract XML file name.
|
void |
setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperties)
Sets the request properties of this command implementation.
|
void |
setUrl(java.lang.String astrUrl)
Sets the redirect URL to be called when the command completes successfully.
|
void |
setXMLEntityPath(java.lang.String path)
Sets the XML entity path.
|
void |
setXSDFlag(boolean xsdFlag)
Sets the XSD flag to indicate the XML instance file is based on XSD or dtd
|
void |
validateParameters()
Extracts and validates the input parameters of this command implementation.
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
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
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
public static final java.lang.String CLASSNAME
public static final java.lang.String COPYRIGHT
public java.lang.String getUrl()
public void performExecute() throws com.ibm.commerce.exception.ECException
performExecute
in interface com.ibm.commerce.command.ECCommand
performExecute
in class com.ibm.commerce.command.AbstractECTargetableCommand
com.ibm.commerce.exception.ECException
- Raised with message _ERR_FINDER_EXCEPTION if the FinderException occurred.
Raised with message _ERR_REMOTE_EXCEPTION if the RemoteException occurred.
Raised with message _ERR_NAMING_EXCEPTION if the NamingException occurred.
Raised with message _ERR_CREATE_EXCEPTION if the CreateException occurred.
Raised with message _ERR_SQL_EXCEPTION if the SQLException occurred.public void setContractXML(java.io.InputStream contractXML)
setContractXML
in interface ContractImportDraftVersionCmd
contractXML
- an InputStream object contains the contract XML instancepublic void setContractXMLFileName(java.lang.String contractFileName)
setContractXMLFileName
in interface ContractImportDraftVersionCmd
contractFileName
- the name of the contract XML filepublic void setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperties) throws com.ibm.commerce.exception.ECApplicationException
setRequestProperties
in interface com.ibm.commerce.command.ControllerCommand
setRequestProperties
in class com.ibm.commerce.command.ControllerCommandImpl
aRequestProperties
- the request properties
The mandatory name-value pairs are fileName, URL.
The optional name-value pairs are XSD, validate, and path. if the XSD parameter is set to true, it means the
XML file is based on XSD. Otherwise it is dtd based. The default value for the XSD parameter is false.
The validate parameter indicates if the XML parser will validate the XML file against XSD/DTD. true - validate, false - do not validate.
The default value of the validate parameter is true. The path parameter indicates the path of the dtd or XML schema files. The default
value of the path parameter is specified in WebSphere Commerce instance XML file.com.ibm.commerce.exception.ECApplicationException
- Raised with message _ERR_MISSING_CMD_PARAMETER when any one of the required URL parameters is missing.public void setUrl(java.lang.String astrUrl)
setUrl
in interface ContractImportDraftVersionCmd
astrUrl
- the redirect URL stringpublic void setXMLEntityPath(java.lang.String path)
setXMLEntityPath
in interface ContractImportDraftVersionCmd
path
- the path where it can find the dtd or XML Schema file(s)public void setXSDFlag(boolean xsdFlag)
setXSDFlag
in interface ContractImportDraftVersionCmd
setXSDFlag
in class TradingAgreementImportBaseCmdImpl
xsdFlag
- XSD flag, true for XSD, false for dtdpublic void validateParameters() throws com.ibm.commerce.exception.ECException
validateParameters
in interface com.ibm.commerce.command.ECCommand
validateParameters
in class com.ibm.commerce.command.AbstractECTargetableCommand
com.ibm.commerce.exception.ECException
- Raised with message _ERR_FILE_NOT_FOUND if the XML file or XSD 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_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.
Raised with message _ERR_MISSING_XML_INSTANCE_FOR_CONTRACT_IMPORT if there is not any XML instance object for this command.
Raised with message _ERR_XML_DOCUMENT_NULL if there is not Document object in the XML instance.
Raised with message _ERR_MISSING_CONTRACT_OR_CONTRACT_DESC_ELEMENT if neither of the contract and contract national language description element is in XML instance.