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

Class ComposeCatalogGroupMerchandisingAssociationsTaskCmdImpl

java.lang.Object

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

All Implemented Interfaces:

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

public class ComposeCatalogGroupMerchandisingAssociationsTaskCmdImpl
extends java.lang.Object
implements ComposeCatalogGroupTaskCmd

This class is used to get the merchandising association details of a category. The following details about the category will be returned. *

• /CatalogGroup/CatalogGroupIdentifier/UniqueID
• /CatalogGroup/CatalogGroupIdentifier/ExternalIdentifier(@ownerID)
• /CatalogGroup/CatalogGroupIdentifier/ExternalIdentifier(@ownerID)/GroupIdentifier
• /CatalogGroup/Description(@language)/Name
• /CatalogGroup/Description(@language /ThumbNail
• /CatalogGroup/Description(@language /ShortDescription
• /CatalogGroup/Description(@language) /FullImage
• /CatalogGroup/Description(@language) /LongDescription
• /CatalogGroup/Association(@quantity @sequence)
• /CatalogGroup/Association(@quantity @sequence)/Name
• /CatalogGroup/Association(@quantity @sequence)/ AssociationCodeType
• /CatalogGroup/Association(@quantity @sequence)/CatalogGroupReference/displayName
• /CatalogGroup/Association(@quantity @sequence)/ CatalogGroupReference /CatalogGroupIdentifier/UniqueID
• /CatalogGroup/Association(@quantity @sequence)/ CatalogGroupReference/CatalogGroupIdentifier/ExternalIdentifier(@ownerID)
• /CatalogGroup/Association(@quantity @sequence)/ CatalogGroupReference/CatalogGroupIdentifier/ExternalIdentifier(@ownerID)/GroupIdentifier Here AssociationCodeType is MerchandisingAssociation

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
ComposeCatalogGroupMerchandisingAssociationsTaskCmdImpl() The default constructor for this class.

Method Summary

Modifier and Type	Method and Description
void	execute() Composes the category merchandising associations.
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() This method checks if the catalog group data bean required to extract the required data has been set.
void	reset() This method resets the value of the catalog group data bean to null.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComposeCatalogGroupMerchandisingAssociationsTaskCmdImpl

public ComposeCatalogGroupMerchandisingAssociationsTaskCmdImpl()

The default constructor for this 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 which contains the information about the Category.

execute

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

Composes the category merchandising associations. This method composes the details of the category, along with it's merchandising associations with other catalog groups. The details returned include, the catgroup id, identifier, name, thumbnail image location, full image location, short description, long description, language id, owner id. Along with these details of the category the merchandising association details are returned. These details are association code type (presently set to MerchandisingAssociation), display name of the associated catgroup, it's catgroup id, owner id, identifier. These can be represented by the following Xpath.

• /CatalogGroup/CatalogGroupIdentifier/UniqueID
• /CatalogGroup/CatalogGroupIdentifier/ExternalIdentifier(@ownerID)
• /CatalogGroup/CatalogGroupIdentifier/ExternalIdentifier(@ownerID)/GroupIdentifier
• /CatalogGroup/Description(@language)/Name
• /CatalogGroup/Description(@language /ThumbNail
• /CatalogGroup/Description(@language /ShortDescription
• /CatalogGroup/Description(@language) /FullImage
• /CatalogGroup/Description(@language) /LongDescription
• /CatalogGroup/Association(@quantity @sequence)
• /CatalogGroup/Association(@quantity @sequence)/Name
• /CatalogGroup/Association(@quantity @sequence)/ AssociationCodeType
• /CatalogGroup/Association(@quantity @sequence)/CatalogGroupReference/displayName
• /CatalogGroup/Association(@quantity @sequence)/ CatalogGroupReference /CatalogGroupIdentifier/UniqueID
• /CatalogGroup/Association(@quantity @sequence)/ CatalogGroupReference/CatalogGroupIdentifier/ExternalIdentifier(@ownerID)
• /CatalogGroup/Association(@quantity @sequence)/ CatalogGroupReference/CatalogGroupIdentifier/ExternalIdentifier(@ownerID)/GroupIdentifier Here AssociationCodeType is MerchandisingAssociation

Specified by:

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

Throws:

com.ibm.websphere.command.CommandException - The category data bean throws an exception while extracting the required fields.

isReadyToCallExecute

public boolean isReadyToCallExecute()

This method checks if the catalog group data bean required to extract the required data has been set.

Specified by:

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

Returns:

true if ready, false otherwise.

reset

public void reset()

This method resets the value of the catalog group data bean to null.

Specified by:

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

setCatalogGroupDataBean

public void setCatalogGroupDataBean(CategoryDataBean catgrpDataBean)

Parameters:

catgrpDataBean - the CategoryDataBean.

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 page 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:

The reference id.