public class AccountExportCmdImpl extends TradingAgreementExportBaseCmdImpl implements AccountExportCmd
AccountExportCmd
controller command.
Name | Description |
---|---|
accountId |
The account IDs to be exported. It is mandatory. |
fileName |
The file name of the exporting xml file. It is mandatory. |
langId |
The language ID. It is mandatory. |
xsdName |
xsd file name when exporting a contract. It is mandatory. |
URL |
the url which contract is exported to. It is mandatory. |
xmlFileEncoding |
the xml file encoding. It is optional. |
tagName |
the tag name of the contract. It is optional. |
TradingAgreementAccessBean
AccountAccessBean
AttachmentAccessBean
LanguageAccessBean
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 |
---|
AccountExportCmdImpl() |
Modifier and Type | Method and Description |
---|---|
com.ibm.commerce.accesscontrol.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()
Executes the business logic of this command implementation.
|
void |
setAccountId(java.lang.Long accountId)
Sets the ID of the business account to be exported.
|
void |
setExportAllData(boolean wantsAll)
Sets the exporting all data flag.
|
void |
setFileName(java.lang.String astrFileName)
Sets the xml file which the business account will be exported to.
|
void |
setLangId(java.lang.Integer anLangId)
Sets language ID.
|
void |
setRequestProperties(com.ibm.commerce.datatype.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()
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, 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, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
public static final java.lang.String CLASSNAME
public static final java.lang.String COPYRIGHT
public com.ibm.commerce.accesscontrol.AccessVector getResources() throws com.ibm.commerce.exception.ECException
getResources
in interface com.ibm.commerce.command.ECCommand
getResources
in class com.ibm.commerce.command.AbstractECTargetableCommand
com.ibm.commerce.exception.ECException
AbstractECTargetableCommand.getResources()
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_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 setAccountId(java.lang.Long accountId)
setAccountId
in interface AccountExportCmd
accountId
- the ID of the business account.public void setExportAllData(boolean wantsAll)
setExportAllData
in interface AccountExportCmd
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 AccountExportCmd
astrFileName
- the name of the xml filepublic void setLangId(java.lang.Integer anLangId)
setLangId
in interface AccountExportCmd
anLangId
- the language IDpublic 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 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. That 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.com.ibm.commerce.exception.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 AccountExportCmd
astrUrl
- the redirection url stringpublic void setXMLFileEncoding(java.lang.String encoding)
setXMLFileEncoding
in interface AccountExportCmd
encoding
- the encoding stringpublic void setXSDFileName(java.lang.String xsdName)
setXSDFileName
in interface AccountExportCmd
xsdName
- The name of the xsd files which the contract xml should against for.public 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_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.