public class CatalogDataBean extends CatalogAccessBean implements com.ibm.commerce.catalog.beans.CatalogInputDataBean, com.ibm.commerce.catalog.beans.CatalogSmartDataBean
You can find more information about data beans in the WebSphere Commerce data beans topic in the Information Center.
Access Beans: Catalog
Mandatory Parameters (for single row retrieval):
Some hints and tips for using this data bean are:
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
The internal copyright field.
|
emptyString
Constructor and Description |
---|
CatalogDataBean()
Constructs an empty
CatalogDataBean . |
CatalogDataBean(CatalogAccessBean abCatalog)
Constructs a
CatalogDataBean from a CatalogAccessBean . |
CatalogDataBean(CatalogAccessBean abCatalog,
CommandContext aCommandContext)
Constructs a
CatalogDataBean from a CatalogAccessBean and the command context. |
Modifier and Type | Method and Description |
---|---|
AttachmentDataBean[] |
getAllAttachments()
Gets all the attachments in the catalog.
|
AttachmentDataBean[] |
getAttachmentsByUsage()
Gets all the catalog attachments by the specified attachment relation usage.
|
AttachmentUsageDataBean[] |
getAttachmentUsages()
Gets all the attachment relation usage used in the catalog attachments
If there are no attachment usages to return then this method will return a zero length array.
|
java.lang.String |
getCatalogId()
Gets the catalog ID that represents the primary key for this catalog.
|
CommandContext |
getCommandContext()
Gets the current command's context
|
CatalogDescriptionAccessBean |
getDescription()
Gets a bean representing descriptive information about this catalog.
|
java.lang.String |
getIdentifier()
Gets the external identifier of the catalog.
|
java.lang.String |
getObjectPath()
Gets the path to objects such as images in the context of the current store.
|
TypedProperty |
getRequestProperties()
Gets the request property passed in at run time.
|
CategoryDataBean[] |
getTopCategories()
Gets a list of data beans that represent the top categories of this catalog.
|
boolean |
isAdminMode()
Is the bean used in administrative mode.
|
void |
populate()
Fetches and populates information needed by the bean.
|
void |
setAdminMode(boolean aboolAdminMode)
Sets the administrative mode of the bean.
|
void |
setAttachmentUsage(java.lang.String astrAttachmentUsage)
Sets the attachment relation usage identifier to get all the attachments of the catalog with the same usage.
|
void |
setCatalogId(java.lang.String astrCatalogId)
Sets the catalog ID that represents the primary key for this catalog.
|
void |
setCommandContext(CommandContext commandContext)
Sets the command context passed in at run time.
|
void |
setDescription(CatalogDescriptionAccessBean aabDescription)
Sets the description for the catalog.
|
void |
setIdentifier(java.lang.String astrIdentifier)
Sets the external identifier for this catalog.
|
void |
setRequestProperties(TypedProperty param)
Sets the request property and populates the parameters that are needed by the bean.
|
findByCatalogIdentifierAndStore, findByCatalogIdentifierAndStoreNoCache, findByKeyAndStore, findByKeyAndStoreNoCache, findByMemberIdAndCatalogIdentifier, findByMemberIdAndCatalogIdentifierNoCache, findByStoreId, findByStoreIdNoCache, findMasterCatalogByStoreId, findMasterCatalogByStoreIdNoCache, fulfills, getCatalogGroups, getCatalogGroupsByStore, getCatalogReferenceNumber, getCatalogReferenceNumberInEntityType, getDescription, getDescription, getDescriptionNoCache, getDescriptions, getEntitledCatalogGroups, getEntitledCatalogGroupsByStore, getEntitledCatalogGroupsByStore, getEntity, getLanguage_id, getLanguage_idInEntityType, getMemberId, getMemberIdInEntityType, getOwner, getTPCLevel, getTPCLevelInEntityType, instantiateEntity, isCatalogInStore, setDescriptions, setInitKey_catalogReferenceNumber, setInitKey_catalogReferenceNumber, setMemberId, setMemberId, setTPCLevel, setTPCLevel
public static final java.lang.String COPYRIGHT
public CatalogDataBean()
CatalogDataBean
.public CatalogDataBean(CatalogAccessBean abCatalog)
CatalogDataBean
from a CatalogAccessBean
.abCatalog
- The CatalogAccessBean
.RemoteException
- In the execution of the method, a remote exception occurs.FinderException
- In the execution of the method, a finder exception occurs.NamingException
- In the execution of the method, a naming exception occurs.CreateException
- In the execution of the method, a create exception occurs.public CatalogDataBean(CatalogAccessBean abCatalog, CommandContext aCommandContext)
CatalogDataBean
from a CatalogAccessBean
and the command context.abCatalog
- The CatalogAccessBean
.aCommandContext
- The command context as CommmnadContext
object.RemoteException
- In the execution of the method, a remote exception occurs.FinderException
- In the execution of the method, a finder exception occurs.NamingException
- In the execution of the method, a naming exception occurs.CreateException
- In the execution of the method, a create exception occurs.public java.lang.String getCatalogId()
getCatalogId
in interface com.ibm.commerce.catalog.beans.CatalogSmartDataBean
public AttachmentDataBean[] getAllAttachments()
AttachmentDataBean
public AttachmentDataBean[] getAttachmentsByUsage()
setAttachmentUsage
method.
If there are no attachments to return this method will return a zero length array.AttachmentDataBean
public AttachmentUsageDataBean[] getAttachmentUsages()
AttachmentUsageDataBean
public CommandContext getCommandContext()
getCommandContext
in interface SmartDataBean
CommandContext
object.public CatalogDescriptionAccessBean getDescription()
getDescription
in interface com.ibm.commerce.catalog.beans.CatalogSmartDataBean
getDescription
in class CatalogAccessBean
CatalogDescriptionAccessBean
.RemoteException
- In the execution of the method, a remote exception occurs.FinderException
- In the execution of the method, a finder exception occurs.NamingException
- In the execution of the method, a naming exception occurs.CreateException
- In the execution of the method, a create exception occurs.public java.lang.String getIdentifier()
getIdentifier
in interface com.ibm.commerce.catalog.beans.CatalogSmartDataBean
getIdentifier
in class CatalogAccessBean
public java.lang.String getObjectPath() throws ECException
ECException
- An exception occurs during the execution of the method.public TypedProperty getRequestProperties()
getRequestProperties
in interface InputDataBean
null
is always returned.public CategoryDataBean[] getTopCategories() throws ECException
isAdminMode
returns true
then, no entitlement checking is performed to return the top categories.
isAdminMode
returns false
, then a check is made to see if Search Feature is enabled.
CheckCatalogGroupEntitlementCmd
command is used to check for entitlement and get the list of CatalogGroupAccessBean.
isAdminMode
returns false
, search is not enabled and entitlement check is required,
the method getEntitledCatalogGroupsByStore(java.lang.Integer, java.util.Vector[], java.util.Vector[]) will be called to return the list of catalog group access beans.
isAdminMode
returns false
, search is not enabled and entitlement check is not required,
the method getCatalogGroupsByStore(Integer) will be called to return the list of catalog group access beans.
getTopCategories
in interface com.ibm.commerce.catalog.beans.CatalogSmartDataBean
CategoryDataBean
.ECException
- An exception occurs during the execution of the method.public void populate()
populate
in interface SmartDataBean
RemoteException
- In the execution of the method, a remote exception occurs.FinderException
- In the execution of the method, a finder exception occurs.NamingException
- In the execution of the method, a naming exception occurs.CreateException
- In the execution of the method, a create exception occurs.public void setCatalogId(java.lang.String astrCatalogId)
setCatalogId
in interface com.ibm.commerce.catalog.beans.CatalogInputDataBean
astrCatalogId
- The catalog ID.public void setCommandContext(CommandContext commandContext)
setCommandContext
in interface SmartDataBean
aCommandContext
- The command context as CommandContext
object.public void setAttachmentUsage(java.lang.String astrAttachmentUsage)
astrAttachmentUsage
- The attachment relation usage identifierpublic void setIdentifier(java.lang.String astrIdentifier)
setIdentifier
in interface com.ibm.commerce.catalog.beans.CatalogInputDataBean
setIdentifier
in class CatalogAccessBean
astrIdentifier
- The external identifier of the catalog.public void setRequestProperties(TypedProperty param)
setRequestProperties
in interface InputDataBean
param
- The request property as TypedProperty
object.public boolean isAdminMode()
true
,
we do not need to check for entitlements for getTopCategories()
.false
is the default value. Returns true
if the bean is used in administrative mode.public void setAdminMode(boolean aboolAdminMode)
iboolAdminMode
- true
to used the bean in administrative mode; otherwise false
.public void setDescription(CatalogDescriptionAccessBean aabDescription)
aabDescription
- The CatalogDescriptionAccessBean
.