com.ibm.commerce.contract.commands
Interface ContractExportCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable
All Known Implementing Classes:
ContractExportCmdImpl

public interface ContractExportCmd
extends ControllerCommand

Export a specified contract with specified language id to a xml file based on the specified encoding (WebSphere Commerce Business Edition only).


Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
static java.lang.String defaultCommandClassName
          The default implementation class is "com.ibm.commerce.contract.commands.ContractExportCmdImpl".
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.contract.commands.ContractExportCmd".
 
Method Summary
 void setContractId(java.lang.Long contractId)
          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 langId)
          Set language id.
 void setUrl(java.lang.String astrUrl)
          Set the redirection url to be called when the command completes successfully.
 void setXMLFileEncoding(java.lang.String encoding)
          Set the encoding.
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
The internal copyright field.

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class is "com.ibm.commerce.contract.commands.ContractExportCmdImpl".

NAME

public static final java.lang.String NAME
The name of this interface is "com.ibm.commerce.contract.commands.ContractExportCmd".
Method Detail

setContractId

public void setContractId(java.lang.Long contractId)
Set the id of the contract to export.
Parameters:
contractId - java.lang.Long

setFileName

public void setFileName(java.lang.String astrFileName)
Set the xml file which the contract exports to.
Parameters:
astrFileName - java.lang.String

setLangId

public void setLangId(java.lang.Integer langId)
Set language id.
Parameters:
langId - java.lang.Integer

setUrl

public void setUrl(java.lang.String astrUrl)
Set the redirection url to be called when the command completes successfully.
Parameters:
astrUrl - java.lang.String - redirection url string

setXMLFileEncoding

public void setXMLFileEncoding(java.lang.String encoding)
Set the encoding.
Parameters:
encoding - java.lang.String