com.ibm.commerce.productset.commands
Interface ProductSetPublishCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand

public interface ProductSetPublishCmd
extends ControllerCommand

This command publishes one or more product sets specified by an input list of product set IDs. If a list is not provided and publish all is specified, then all the non-static product sets defined will be published. Publishing a product set results in creating the set of products and SKUs from a catalog that is described by the product set's XML definition. If a product set has been previously published, this command will remove the existing products and SKUs from the product set and populate it with the set of products and SKUs based on the product set's XML definition. This command will need to be called to publish all product sets by customers who have contracts deployed for entitlement and price adjustments and have performed a batch load of new products and SKUs.

Input parameters:

Name Type Requirement Description
ProductSetID Array of Integer optional The list of product set IDs which needs to be published. PublishAll Boolean optional True if all non-static product sets need to be published. False otherwise.

Output parameters:

Name Type Description

Behavior:

Exception:


Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
static java.lang.String defaultCommandClassName
          The fully qualified name of the default implementation class.
static java.lang.String NAME
          The fully qualified name of this class.
static java.lang.String URLNAME
          The url name of this class.
 
Method Summary
 boolean isExclusion()
          Returns true if the exclusion flag has been set.
 void setExclusion(boolean abExclusion)
          Sets the exclusion flag.
 void setProductSetId(java.lang.Integer newProductsetId)
          Sets the Product Set id that represents the primary key of the Product Set.
 void setProductSetIds(java.lang.Integer[] newProductsetIds)
          Sets the Product Set id that represents the primary key of the Product Set.
 void setProductSetXml(java.lang.String xml)
          Sets the product set xml to publish.
 void setPublishAll(boolean aPublishAll)
          Sets the publish all flag.
 
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
The internal copyright field.
See Also:
Constant Field Values

NAME

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

URLNAME

public static final java.lang.String URLNAME
The url name of this class.
See Also:
Constant Field Values

defaultCommandClassName

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

isExclusion

public boolean isExclusion()
Returns true if the exclusion flag has been set.
Returns:
returns true if the exclusion flag has been set.

setExclusion

public void setExclusion(boolean abExclusion)
Sets the exclusion flag.
Parameters:
abExclusion - the value of the exclusion flag to be set.

setProductSetId

public void setProductSetId(java.lang.Integer newProductsetId)
Sets the Product Set id that represents the primary key of the Product Set.
Parameters:
newProductsetId - the Product Set id value to be set.

setProductSetIds

public void setProductSetIds(java.lang.Integer[] newProductsetIds)
Sets the Product Set id that represents the primary key of the Product Set.
Parameters:
newProductsetIds - the Product Set id.

setPublishAll

public void setPublishAll(boolean aPublishAll)
Sets the publish all flag.
Parameters:
aPublishAll - the publish all flag value to be set.

setProductSetXml

public void setProductSetXml(java.lang.String xml)
Sets the product set xml to publish. Do not read the xml from the database.
Parameters:
xml - the product set xml.