com.ibm.commerce.catalog.facade.server.commands

Class ComposeCatalogGroupDetailsTaskCmdImpl

java.lang.Object

com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogGroupDetailsTaskCmdImpl

All Implemented Interfaces:

ComposeCatalogGroupTaskCmd, com.ibm.websphere.command.Command, java.io.Serializable

public class ComposeCatalogGroupDetailsTaskCmdImpl
extends java.lang.Object
implements ComposeCatalogGroupTaskCmd

This class is used to get the details of a single category. This class is used for the access profile specified by the key, WC_CatalogGroupDetailsProfile. The details included in this profile are,

• /CatalogGroup/CatalogIdentifier/CatalogID
• /CatalogGroup/CatalogIdentifier/Identifier
• /CatalogGroup/Description/Name
• /CatalogGroup/Description/ThumbNail
• /CatalogGroup/Description/FullImage
• /CatalogGroup/Description/ShortDescription
This access profile also contains the display template name value pair to the CatalogGroup noun. This indicates the display template to be used for the category. The attribute name used in Show BOD for display template is 'displayTemplate'. To get these details, set the category data bean using,setCatalogGroups(), and call the execute(). The details will be in the CatalogGroupType object, which can be obtained by getCatalogGroup().

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogGroupTaskCmd

DEFAULTCOMMANDCLASSNAME, NAME

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ComposeCatalogGroupDetailsTaskCmdImpl() Default constructor for the class.

Method Summary

Modifier and Type	Method and Description
void	execute() Composes the category details.
CatalogGroupType	getCatalogGroup() This method gets the ShowCatalogGroup BOD.
boolean	getRecordSetCompleteIndicator()
java.math.BigInteger	getRecordSetCount()
java.lang.String	getRecordSetReferenceId() Not supported
java.math.BigInteger	getRecordSetStartNumber()
java.math.BigInteger	getRecordSetTotal()
boolean	isReadyToCallExecute()
void	reset()
void	setCatalogGroupDataBean(CategoryDataBean catgrpDataBean)
void	setCatalogGroups(java.util.ArrayList vCatalogGroups) This method sets the catalog group data bean vector.
void	setPagingParams(java.math.BigInteger begIndex, java.math.BigInteger dispNum) Paging is not supported for this command, the parameters passed will be ignored.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComposeCatalogGroupDetailsTaskCmdImpl

public ComposeCatalogGroupDetailsTaskCmdImpl()

Default constructor for the class.

Method Detail

getCatalogGroup

public CatalogGroupType getCatalogGroup()

Description copied from interface: ComposeCatalogGroupTaskCmd

This method gets the ShowCatalogGroup BOD.

Specified by:

getCatalogGroup in interface ComposeCatalogGroupTaskCmd

Returns:

the CatalogGroupType, containing the category information.

execute

public void execute()
             throws com.ibm.websphere.command.CommandException

Composes the category details. This method is used to compose the details of the required category. The details include categoryId, category name, thumbnail image location,full image location, short description and the long description. The details returned are as follows

• /CatalogGroup/CatalogIdentifier/CatalogID
• /CatalogGroup/CatalogIdentifier/Identifier
• /CatalogGroup/Description/Name
• /CatalogGroup/Description/ThumbNail
• /CatalogGroup/Description/FullImage
• /CatalogGroup/Description/ShortDescription
This method also adds the display template name value pair to the CatalogGroup noun. The attribute name used in Show BOD for display template is 'displayTemplate'. This works on following algorithm: -- Lookup in DISPCGPREL by CATGROUP_ID, LANGUAGE_ID, and STORE_ID (STORE_ID should be store path enabled) -- If not found: Lookup in DISPCGPREL for CATGROUP_ID=0, by LANGUAGE_ID, and STORE_ID (STORE_ID should be store path enabled) -- If still not found: Repeat above two steps using the store default language, then the site default language. If at any step multiple records are found, use the one with the highest RANK value The method uses CatalogGroupPageRelationAccessBean.findByStoreCategoryMemberLanguageId() which works on the algorithm specified above.

Specified by:

execute in interface com.ibm.websphere.command.Command

Throws:

com.ibm.websphere.command.CommandException - when the required an exception occurs while extracting individual fields from the catalog group data bean.

isReadyToCallExecute

public boolean isReadyToCallExecute()

Specified by:

isReadyToCallExecute in interface com.ibm.websphere.command.Command

Returns:

true if ready, false otherwise.

reset

public void reset()

Specified by:

reset in interface com.ibm.websphere.command.Command

setCatalogGroupDataBean

public void setCatalogGroupDataBean(CategoryDataBean catgrpDataBean)

Parameters:

catgrpDataBean - the category data bean to be used for compose.

setPagingParams

public void setPagingParams(java.math.BigInteger begIndex,
                            java.math.BigInteger dispNum)

Paging is not supported for this command, the parameters passed will be ignored.

Specified by:

setPagingParams in interface ComposeCatalogGroupTaskCmd

Parameters:

begIndex - the beginning index.

dispNum - the paging size.

setCatalogGroups

public void setCatalogGroups(java.util.ArrayList vCatalogGroups)

Description copied from interface: ComposeCatalogGroupTaskCmd

This method sets the catalog group data bean vector.

Specified by:

setCatalogGroups in interface ComposeCatalogGroupTaskCmd

Parameters:

vCatalogGroups - a list of catalog group data bean.

getRecordSetCompleteIndicator

public boolean getRecordSetCompleteIndicator()

Specified by:

getRecordSetCompleteIndicator in interface ComposeCatalogGroupTaskCmd

Returns:

false.

getRecordSetCount

public java.math.BigInteger getRecordSetCount()

Specified by:

getRecordSetCount in interface ComposeCatalogGroupTaskCmd

Returns:

null.

getRecordSetStartNumber

public java.math.BigInteger getRecordSetStartNumber()

Specified by:

getRecordSetStartNumber in interface ComposeCatalogGroupTaskCmd

Returns:

null.

getRecordSetTotal

public java.math.BigInteger getRecordSetTotal()

Specified by:

getRecordSetTotal in interface ComposeCatalogGroupTaskCmd

Returns:

null.

getRecordSetReferenceId

public java.lang.String getRecordSetReferenceId()

Not supported

Specified by:

getRecordSetReferenceId in interface ComposeCatalogGroupTaskCmd

Returns:

null.