com.ibm.commerce.contract.commands
Class ContractExportCmdImpl
com.ibm.commerce.command.AbstractECTargetableCommand
|
+--com.ibm.commerce.command.ControllerCommandImpl
|
+--com.ibm.commerce.contract.commands.ContractExportCmdImpl
- All Implemented Interfaces:
- AccCommand, ContractExportCmd, ControllerCommand, ECCommand, ECTargetableCommand, Protectable
- public class ContractExportCmdImpl
- extends ControllerCommandImpl
- implements ContractExportCmd
Export a specified contract with specified language id to a xml file based on
the specified encoding (WebSphere Commerce Business Edition only).
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()
Contains the actual business logic of the command
It should be implemented by all the command writer. |
void |
setContractId(java.lang.Long anContractId)
Set the id of the contract to export. |
void |
setFileName(java.lang.String astrFileName)
Set the xml file which the contract exports to. |
void |
setLangId(java.lang.Integer anLangId)
Set language id. |
void |
setRequestProperties(TypedProperty aRequestProperties)
The WebController calls this method before invoking the execute method in this command to
set the request properties for this command. |
void |
setUrl(java.lang.String astrUrl)
Sets the redirection url to be called when the command completes successfully. |
void |
setXMLFileEncoding(java.lang.String encoding)
Set the encoding. |
void |
validateParameters()
Performs server side parameter checking. |
Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl |
fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties |
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand |
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties |
Methods inherited from interface com.ibm.commerce.command.ControllerCommand |
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setDefaultProperties |
CLASSNAME
public static final java.lang.String CLASSNAME
COPYRIGHT
public static final java.lang.String COPYRIGHT
ContractExportCmdImpl
public ContractExportCmdImpl()
getResources
public AccessVector getResources()
throws ECException
- Gets the access vector accessed by this command.
The default implementation returns null indicating that no protectable resource is
accessed by this command. It is the responsibilities of the command writer to
return the protectable primary resource(s) and the corresponding actions accessed
by this command.
- Specified by:
getResources
in interface ECCommand
- Overrides:
getResources
in class AbstractECTargetableCommand
- Returns:
- AccessVector - a vector of resource action pairs
getUrl
public java.lang.String getUrl()
- Gets the redirection url to be called when the command completes successfully.
performExecute
public void performExecute()
throws ECException
- Description copied from interface:
ECCommand
- Contains the actual business logic of the command
It should be implemented by all the command writer.
- Specified by:
performExecute
in interface ECCommand
- Overrides:
performExecute
in class AbstractECTargetableCommand
- Following copied from interface:
com.ibm.commerce.command.ECCommand
- Throws:
com.ibm.commerce.command.CommandException
- The superclass for all ECExceptions.
setContractId
public void setContractId(java.lang.Long anContractId)
- Set the id of the contract to export.
- Specified by:
setContractId
in interface ContractExportCmd
- Parameters:
contractId
- java.lang.Long
setFileName
public void setFileName(java.lang.String astrFileName)
- Set the xml file which the contract exports to.
- Specified by:
setFileName
in interface ContractExportCmd
- Parameters:
astrFileName
- java.lang.String
setLangId
public void setLangId(java.lang.Integer anLangId)
- Set language id.
- Specified by:
setLangId
in interface ContractExportCmd
- Parameters:
langId
- java.lang.Integer
setRequestProperties
public void setRequestProperties(TypedProperty aRequestProperties)
throws ECApplicationException
- Description copied from interface:
ControllerCommand
- The WebController calls this method before invoking the execute method in this command to
set the request properties for this command.
It is the responsibility of the implementer of the ControllerCommand to extract the
required input parameters from the request properties and perform parameter checking.
- Specified by:
setRequestProperties
in interface ControllerCommand
- Overrides:
setRequestProperties
in class ControllerCommandImpl
- Following copied from interface:
com.ibm.commerce.command.ControllerCommand
- Parameters:
requestProperties
- com.ibm.commerce.datatype.TypedProperty- Throws:
com.ibm.commerce.exception.ECException.
-
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 ContractExportCmd
- Parameters:
astrUrl
- java.lang.String - redirection url string
setXMLFileEncoding
public void setXMLFileEncoding(java.lang.String encoding)
- Set the encoding.
- Specified by:
setXMLFileEncoding
in interface ContractExportCmd
- Parameters:
encoding
- java.lang.String
validateParameters
public void validateParameters()
throws ECException
- Description copied from interface:
ECCommand
- Performs server side parameter checking. This method replaces the checkParameters() method in a previous
version of the code.
- Specified by:
validateParameters
in interface ECCommand
- Overrides:
validateParameters
in class AbstractECTargetableCommand
- Following copied from interface:
com.ibm.commerce.command.ECCommand
- Throws:
ECException.
-