java.lang.Object | +--TradingAgreementExportBaseCmdImpl | +--com.ibm.commerce.contract.commands.ContractExportCmdImpl
Exports the specified contract using the specified language ID to a XML file based on the specified encoding (WebSphere Commerce Business Edition only). The following EJBs are used within the default implementation: ContractAccessBean, TradingAgreementAccessBean, AttachmentAccessBean, LanguageAccessBean, ParticipantAccessBean, TermConditionDescriptionAccessBean, TradingDescriptionAccessBean, AccountAccessBean, TermConditionAccessBean.
Field Summary | |
---|---|
static java.lang.String |
CLASSNAME The name of this command. |
static java.lang.String |
COPYRIGHT IBM copyright notice field. |
Fields inherited from interface com.ibm.commerce.contract.commands. ContractExportCmd |
defaultCommandClassName,
NAME |
Constructor Summary | |
---|---|
ContractExportCmdImpl() |
Method Summary | |
---|---|
AccessVector |
getResources() Gets the access vector accessed by this command. |
java.lang.String |
getUrl() Gets the redirection url to be called when the command completes successfully. |
void |
performExecute() Exports the specified contract. |
void |
setContractId(java.lang.Long contractId) Sets the ID of the contract to be exported. |
void |
setExportAllData(boolean wantsAll) Sets the exporting all data flag. |
void |
setFileName(java.lang.String astrFileName) Sets the XML file to which the contract will be exported. |
void |
setLangId(java.lang.Integer anLangId) Sets the language ID. |
void |
setRequestProperties(
TypedProperty aRequestProperties) Sets the request properties. |
void |
setUrl(java.lang.String astrUrl) Sets the redirection URL to be called when the command completes successfully. |
void |
setXMLFileEncoding(java.lang.String encoding) Sets the encoding. |
void |
setXSDFileName(java.lang.String xsdName) Sets the XSD file name. |
void |
validateParameters() Validates the contract to check if it is in right state for the exporting process. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Methods inherited from interface com.ibm.commerce.command. ControllerCommand |
checkPermission,
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,
getResourceOwners,
setAccCheck,
setForUserId,
setOwner |
Methods inherited from interface com.ibm.commerce.command. ECCommand |
checkIsAllowed,
checkResourcePermission,
createCommandExecutionEvent,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getStoreId,
getUser,
getUserId,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
public static final java.lang.String CLASSNAME
Constructor Detail |
---|
public ContractExportCmdImpl()
Method Detail |
---|
public AccessVector getResources() throws ECException
getResources
in interface
ECCommand
ECException
AbstractECTargetableCommand.getResources()
public java.lang.String getUrl()
public void performExecute() throws ECException
performExecute
in interface
ECCommand
ECException
- Raised with message _ERR_UNSUPPORTED_ENCODING whenever an unsupported encode
is found. Raised with message _ERR_IO_EXCEPTION whenever an IO problem
occurred. Raised with message _ERR_EXPORT_CONTRACT if a problem occurred, but
this command cannot determine the reason. Raised with message
_ERR_CONTRACT_CMD_EXEC whenever one of the following exceptions occurs:
javax.ejb.FinderException, javax.ejb.CreateException, java.rmi.RemoteException,
and javax.naming.NamingException.AbstractECTargetableCommand.performExecute()
public void setContractId(java.lang.Long contractId)
setContractId
in interface
ContractExportCmd
contractId
- the ID of the contract.public void setExportAllData(boolean wantsAll)
setExportAllData
in interface
ContractExportCmd
wantsAll
- the flag to indicate if all the data will be
exported. If the flag is set to true, the contract ID, term and condition IDs,
time created, and the last updated time will be exported. otherwise, the
information will not be exported.public void setFileName(java.lang.String astrFileName)
setFileName
in interface
ContractExportCmd
astrFileName
- the name of the XML filepublic void setLangId(java.lang.Integer anLangId)
setLangId
in interface
ContractExportCmd
anLangId
- the language ID of the descriptions in the
contract.public void setRequestProperties(TypedProperty aRequestProperties) throws ECApplicationException
setRequestProperties
in interface
ControllerCommand
aRequestProperties
- the request properties The mandatory
name-value pairs are contractId, fileName, langId, xsdName, URL. The optional
name-value parameters are xmlFileEncoding, all, tagName. If the xmlFileEncoding
is not provided, the default value will be UTF-8. The default value for name
"all" is set to true which means the ids, create time, update time
will be exported to the specified xml file. If the tagName is not provided,
when a contract is exported, the tag name of the contract will based on the
default implementation. For example, a referral contract, the tag will be
ReferralContract.
ECApplicationException
- Raised with message
_ERR_MISSING_CMD_PARAMETER when any one of the required url parameters is
missing. The required parameters are contractId, langId, fileName, URL, and
xsdName. Raised with message InvalidParameterValueException whenever either the
contradId or langId parameter has the bad format.ControllerCommand#setRequestProperties(TypedProperty)
public void setUrl(java.lang.String astrUrl)
setUrl
in interface
ContractExportCmd
astrUrl
- the redirection URL stringpublic void setXMLFileEncoding(java.lang.String encoding)
setXMLFileEncoding
in interface
ContractExportCmd
encoding
- the encoding stringpublic void setXSDFileName(java.lang.String xsdName)
setXSDFileName
in interface
ContractExportCmd
xsdName
- The name of the XSD file which the contract xml
should against for.public void validateParameters() throws ECException
validateParameters
in interface
ECCommand
ECException
- Raised with message _ERR_CONTRACT_OBJECT_NOT_FOUND if the specified contract
cannot be found. Raised with message _ERR_WRONG_CONTRACT_STATE if the contract
is in one of the following state: EC_STATE_DEPLOY_FAILED,
EC_STATE_DEPLOY_IN_PROGRESS. see
AbstratECTargetableCommand#validateParameters()