com.ibm.commerce.contract.commands
Interface ContractImportApprovedVersionCmd

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

public interface ContractImportApprovedVersionCmd
extends ControllerCommand

Import a contract from a specified XML file (WebSphere Commerce Business Edition only). The state of the contract in the XML file has to be either Approved or Active.


Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.String defaultCommandClassName
          The default implementation class name of this interface.
 
Method Summary
 void setContractXML(java.io.InputStream contractXML)
          Sets the contract XML instance.
 void setContractXMLFileName(java.lang.String contractFileName)
          Sets the contract XML file name.
 void setRootElement(org.w3c.dom.Element rootElement)
          Sets the root Element of the contract XML file.
 void setStoreId(java.lang.Integer storeId)
          Sets the ID of the store to which the contract will be deployed.
 void setUrl(java.lang.String astrUrl)
          Sets the redirect URL to be called when the command completes successfully.
 void setXMLEntityPath(java.lang.String path)
          Sets the XML entity path.
 void setXSDFlag(boolean xsdFlag)
          Sets the XSD flag to indicate the XML instance file is based on XSD or DTD.
 
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

defaultCommandClassName

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

setContractXMLFileName

public void setContractXMLFileName(java.lang.String contractFileName)
Sets the contract XML file name.
Parameters:
contractFileName - the name of the contract XML file

setRootElement

public void setRootElement(org.w3c.dom.Element rootElement)
Sets the root Element of the contract XML file.
Parameters:
rootElement - the document Element object of the contract XML

setStoreId

public void setStoreId(java.lang.Integer storeId)
Sets the ID of the store to which the contract will be deployed.
Parameters:
storeId - the store ID.

setUrl

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

setXMLEntityPath

public void setXMLEntityPath(java.lang.String path)
Sets the XML entity path.
Parameters:
path - the path where can find the DTD or XML Schema file(s)

setXSDFlag

public void setXSDFlag(boolean xsdFlag)
Sets the XSD flag to indicate the XML instance file is based on XSD or DTD.
Parameters:
xsdFlag - XSD flag, true for XSD, false for DTD

setContractXML

public void setContractXML(java.io.InputStream contractXML)
Sets the contract XML instance.
Parameters:
contractXML - an InputStream object contains the contract XML instance