com.ibm.commerce.catalog.commands
Interface ProductDisplayCmd
- All Superinterfaces:
- AccCommand, ControllerCommand, ECCommand, Protectable
- All Known Implementing Classes:
- ProductDisplayCmdImpl
- public interface ProductDisplayCmd
- extends ControllerCommand
The purpose of this command is to retreive the configured Display Page for the specified CatalogEntry which will in turn be
launched in order to display information about the CatalogEntry. CatalogEntries may be entities such as Catalog Items,
Products with defining attributes, Bundles or Packages.
CatalogEntries can be specified in three ways:
- The first method is to provide the primary key (ProductId)
of the CatalogEntry. If the ProductId is not known, the second or third method can be used to uniquely
identify a CatalogEntry.
- The second method is to provide the external PartNumber of the CatalogEntry and a
MemberId that indicates its owner. This MemberId-PartNumber pair uniquely identifies exactly one
CatalogEntry.
- The third method is to simply provide the external PartNumber without supplying a MemberId.
If this method is used, the command assumes that the owning member of the current store is also the owner of the CatalogEntry, so
this MemberId along with the provided PartNumber are used to identify the CatalogEntry.
Field Summary |
static java.lang.String |
COPYRIGHT
The internal copyright field. |
static java.lang.String |
defaultCommandClassName
The default implementation class is "com.ibm.commerce.catalog.commands.ProductDisplayCmdImpl". |
static java.lang.String |
NAME
The name of this interface is "com.ibm.commerce.catalog.commands.ProductDisplayCmd". |
Method Summary |
void |
setMemberId(java.lang.Long anMemberId)
Sets the MemberId (or owner) that along with the PartNumber uniquely identifies the CatalogEntry whose view is to be retrieved. |
void |
setPartNumber(java.lang.String astrPartNumber)
Sets the external PartNumber that along with the MemberId uniquely identifies the CatalogEntry whose view is to be retrieved. |
void |
setProductId(java.lang.Long anProductId)
Sets the ProductId that represents the primary key of the CatalogEntry whose view is to be retrieved. |
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.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
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.catalog.commands.ProductDisplayCmdImpl".
NAME
public static final java.lang.String NAME
- The name of this interface is "com.ibm.commerce.catalog.commands.ProductDisplayCmd".
setMemberId
public void setMemberId(java.lang.Long anMemberId)
- Sets the MemberId (or owner) that along with the PartNumber uniquely identifies the CatalogEntry whose view is to be retrieved.
- Parameters:
anMemberId
- java.jang.Long
setPartNumber
public void setPartNumber(java.lang.String astrPartNumber)
- Sets the external PartNumber that along with the MemberId uniquely identifies the CatalogEntry whose view is to be retrieved.
- Parameters:
astrPartNumber
- java.lang.String
setProductId
public void setProductId(java.lang.Long anProductId)
- Sets the ProductId that represents the primary key of the CatalogEntry whose view is to be retrieved.
- Parameters:
anProductId
- java.lang.Long