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

Class ComposeTopCategoriesTaskCmdImpl

java.lang.Object

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

All Implemented Interfaces:

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

public class ComposeTopCategoriesTaskCmdImpl
extends java.lang.Object
implements ComposeCatalogGroupTaskCmd

This class is used to compose the Top categories of a catalog.

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
ComposeTopCategoriesTaskCmdImpl() Default constructor for the class.

Method Summary

Modifier and Type	Method and Description
void	execute() Composes each Top category of a catalog.
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) This is a setter method for setting tne category data bean for compose command.
void	setCatalogGroups(java.util.ArrayList vCatalogGroups) This is a helper method which sets the catalog group data bean, passed as the first element of the containing list.
void	setPagingParams(java.math.BigInteger begIndex, java.math.BigInteger dispNum) This is a helper method which sets the paging parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComposeTopCategoriesTaskCmdImpl

public ComposeTopCategoriesTaskCmdImpl()

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 information about the category.

execute

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

Composes each Top category of a catalog. This method is used to compose the details of each top category of the required catalog. The details of each top category returned by the command include, The CatalogGroup id, Catalog group identifier, owner id, display sequence and the catalog group name.

Specified by:

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

Throws:

com.ibm.websphere.command.CommandException

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)

This is a setter method for setting tne category data bean for compose command.

Parameters:

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

setPagingParams

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

This is a helper method which sets the paging parameters.

Specified by:

setPagingParams in interface ComposeCatalogGroupTaskCmd

Parameters:

begIndex - The begining index.

dispNum - The page size.

setCatalogGroups

public void setCatalogGroups(java.util.ArrayList vCatalogGroups)

This is a helper method which sets the catalog group data bean, passed as the first element of the containing list.

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:

true if the end of records has been reached, false otherwise

getRecordSetCount

public java.math.BigInteger getRecordSetCount()

Specified by:

getRecordSetCount in interface ComposeCatalogGroupTaskCmd

Returns:

The total count of records

getRecordSetStartNumber

public java.math.BigInteger getRecordSetStartNumber()

Specified by:

getRecordSetStartNumber in interface ComposeCatalogGroupTaskCmd

Returns:

the starting index.

getRecordSetTotal

public java.math.BigInteger getRecordSetTotal()

Specified by:

getRecordSetTotal in interface ComposeCatalogGroupTaskCmd

Returns:

the total number of records.

getRecordSetReferenceId

public java.lang.String getRecordSetReferenceId()

Not supported

Specified by:

getRecordSetReferenceId in interface ComposeCatalogGroupTaskCmd

Returns:

The reference id.