com.ibm.commerce.contract.commands
Interface ContractExportCmd

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

public interface ContractExportCmd
extends ControllerCommand

Exports the specified contract using the specified language ID to a XML file based on the specified encoding (WebSphere Commerce Business Edition only).


Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.String defaultCommandClassName
          The name of the default implementation class.
static java.lang.String NAME
          The name of this interface.
 
Method Summary
 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 langId)
          Sets the language ID.
 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.
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, 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, getResourceOwners, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command. ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of this interface.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The name of the default implementation class.
See Also:
Constant Field Values
Method Detail

setContractId

public void setContractId(java.lang.Long contractId)
Sets the ID of the contract to be exported.
Parameters:
contractId - ID of the contract

setExportAllData

public void setExportAllData(boolean wantsAll)
Sets the exporting all data flag.
Parameters:
wantsAll - the flag to indicate if all the data will be exported. true: exports all the data, false: otherwise

setFileName

public void setFileName(java.lang.String astrFileName)
Sets the XML file to which the contract will be exported.
Parameters:
astrFileName - the name of the XML file

setLangId

public void setLangId(java.lang.Integer langId)
Sets the language ID.
Parameters:
langId - the language ID of the descriptions in the contract.

setUrl

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

setXMLFileEncoding

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

setXSDFileName

public void setXSDFileName(java.lang.String xsdName)
Sets the XSD file name.
Parameters:
xsdName - the name of the XSD file.