ComposeCatalogGroupAllChildrenTaskCmdImpl

java.lang.Object
- com.ibm.commerce.catalog.facade.server.commands.ComposeCatalogGroupAllChildrenTaskCmdImpl

All Implemented Interfaces:

ComposeCatalogGroupTaskCmd, com.ibm.websphere.command.Command, java.io.Serializable
```
public class ComposeCatalogGroupAllChildrenTaskCmdImpl
extends java.lang.Object
implements ComposeCatalogGroupTaskCmd
```
This command composes a Catalog Group noun by including the description of the catalog group and the list of its children. These children include catalog groups and catalog entries. These children are listed using /CatalogGroup/NavigationRelationship. The details of the category and each of the catentry or child category returned include:
- /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/NavigationRelationship(@displaySequence)
- /CatalogGroup/NavigationRelationship/CatalogGroupReference/CatalogGroupIdentifier/UniqueID
- /CatalogGroup/NavigationRelationship/CatalogGroupReference/CatalogGroupIdentifier/ExternalIdentifier(@ownerID)
- /CatalogGroup/NavigationRelationship(@displaySequence)/ CatalogGroupReference/CatalogGroupIdentifier/ExternalIdentifier(@ownerID)/GroupIdentifier
- /CatalogGroup/NavigationRelationship/CatalogGroupReference/displayName
- /CatalogGroup/NavigationRelationship(@displaySequence)/CatalogEntryReference(@catalogEntryTypeCode)/displayName
- /CatalogGroup/NavigationRelationship(@displaySequence)/ CatalogEntryReference(@catalogEntryTypeCode) /CatalogEntryIdentifier/UniqueID
- /CatalogGroup/NavigationRelationship(@displaySequence)/ CatalogEntryReference(@catalogEntryTypeCode)/CatalogEntryIdentifier/ExternalIdentifier(@ownerID)
- /CatalogGroup/NavigationRelationship(@displaySequence)/ CatalogEntryReference(@catalogEntryTypeCode)/CatalogEntryIdentifier/ExternalIdentifier(@ownerID)/PartNumber
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

ComposeCatalogGroupAllChildrenTaskCmdImpl()
Default constructor for the class.

Constructors
Constructor and Description
`ComposeCatalogGroupAllChildrenTaskCmdImpl()` Default constructor for the class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`execute()` Composes the children category and catentry details.
`CatalogGroupType`	`getCatalogGroup()` Gets the `CatalogGroupType` object composed by this command.
`boolean`	`getRecordSetCompleteIndicator()` Gets if the end of records has been reached.
`java.math.BigInteger`	`getRecordSetCount()` Gets the total count of records returned.
`java.lang.String`	`getRecordSetReferenceId()` Not supported
`java.math.BigInteger`	`getRecordSetStartNumber()` Gets the starting index for the records to be returned.
`java.math.BigInteger`	`getRecordSetTotal()` Gets the total number of records for the current criteria.
`boolean`	`isReadyToCallExecute()` Checks if the category data bean is set.
`void`	`reset()` Resets the value of `CatalogGroupType`, `CategoryDataBean` objects to null.
`void`	`setCatalogGroups(java.util.ArrayList vCatalogGroups)` Sets the list of `CatalogGroupDataBean` objects.
`void`	`setPagingParams(java.math.BigInteger begIndex, java.math.BigInteger dispNum)` Sets the beginning index and page size used in paging.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ComposeCatalogGroupAllChildrenTaskCmdImpl
```
public ComposeCatalogGroupAllChildrenTaskCmdImpl()
```
    Default constructor for the class. Three different catalog group compose task command implementations are created based on these access profiles
    - WC_CatalogGroupDetailsProfile
    - WC_CatalogGroupCatalogGroupChildrenProfile
    - WC_CatalogGroupCatalogEntryChildrenProfile
- Method Detail
  - getCatalogGroup
```
public CatalogGroupType getCatalogGroup()
```
    Gets the CatalogGroupType object composed by this command.
    
    Specified by:
    
    getCatalogGroup in interface ComposeCatalogGroupTaskCmd
    
    Returns:
    
    The catalog group type, which would contain the category information.
  - execute
```
public void execute()
             throws com.ibm.websphere.command.CommandException
```
    Composes the children category and catentry details. This method is used to compose the details of the children category and the catentry details of the required category. The details returned include,
    - /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/NavigationRelationship(@displaySequence)
    - /CatalogGroup/NavigationRelationship/CatalogGroupReference/CatalogGroupIdentifier/UniqueID
    - /CatalogGroup/NavigationRelationship/CatalogGroupReference/CatalogGroupIdentifier/ExternalIdentifier(@ownerID)
    - /CatalogGroup/NavigationRelationship(@displaySequence)/ CatalogGroupReference/CatalogGroupIdentifier/ExternalIdentifier(@ownerID)/GroupIdentifier
    - /CatalogGroup/NavigationRelationship/CatalogGroupReference/displayName
    - /CatalogGroup/NavigationRelationship(@displaySequence)/CatalogEntryReference(@catalogEntryTypeCode)/displayName
    - /CatalogGroup/NavigationRelationship(@displaySequence)/ CatalogEntryReference(@catalogEntryTypeCode) /CatalogEntryIdentifier/UniqueID
    - /CatalogGroup/NavigationRelationship(@displaySequence)/ CatalogEntryReference(@catalogEntryTypeCode)/CatalogEntryIdentifier/ExternalIdentifier(@ownerID)
    - /CatalogGroup/NavigationRelationship(@displaySequence)/ CatalogEntryReference(@catalogEntryTypeCode)/CatalogEntryIdentifier/ExternalIdentifier(@ownerID)/PartNumber
    Paging parameters can be specified for paging the results. Set the biginning index and the display count using the setpagingParameters(). The record set count, complete indicator and total number of records can be obtained by the corresponding getter methods.
    Specified by:
    
    execute in interface com.ibm.websphere.command.Command
    
    Throws:
    
    com.ibm.websphere.command.CommandException - when the required data could not be extracted from the category data bean.
  - isReadyToCallExecute
```
public boolean isReadyToCallExecute()
```
    Checks if the category data bean is set.
    
    Specified by:
    
    isReadyToCallExecute in interface com.ibm.websphere.command.Command
    
    Returns:
    
    true if ready, false otherwise.
  - reset
```
public void reset()
```
    Resets the value of CatalogGroupType, CategoryDataBean objects to null.
    
    Specified by:
    
    reset in interface com.ibm.websphere.command.Command
  - setPagingParams
```
public void setPagingParams(java.math.BigInteger begIndex,
                            java.math.BigInteger dispNum)
```
    Sets the beginning index and page size used in paging.
    
    Specified by:
    
    setPagingParams in interface ComposeCatalogGroupTaskCmd
    
    Parameters:
    
    begIndex - the beginning index.
    
    dispNum - the page size.
  - setCatalogGroups
```
public void setCatalogGroups(java.util.ArrayList vCatalogGroups)
```
    Sets the list of CatalogGroupDataBean objects. Only the first one in the list is used by this command.
    
    Specified by:
    
    setCatalogGroups in interface ComposeCatalogGroupTaskCmd
    
    Parameters:
    
    vCatalogGroups - a list of CatalogGroup data bean.
  - getRecordSetCompleteIndicator
```
public boolean getRecordSetCompleteIndicator()
```
    Gets if the end of records has been reached.
    
    Specified by:
    
    getRecordSetCompleteIndicator in interface ComposeCatalogGroupTaskCmd
    
    Returns:
    
    true if the end of records has been reached, false otherwise
  - getRecordSetCount
```
public java.math.BigInteger getRecordSetCount()
```
    Gets the total count of records returned.
    
    Specified by:
    
    getRecordSetCount in interface ComposeCatalogGroupTaskCmd
    
    Returns:
    
    The total count of records returned.
  - getRecordSetStartNumber
```
public java.math.BigInteger getRecordSetStartNumber()
```
    Gets the starting index for the records to be returned.
    
    Specified by:
    
    getRecordSetStartNumber in interface ComposeCatalogGroupTaskCmd
    
    Returns:
    
    the starting index.
  - getRecordSetTotal
```
public java.math.BigInteger getRecordSetTotal()
```
    Gets the total number of records for the current criteria.
    
    Specified by:
    
    getRecordSetTotal in interface ComposeCatalogGroupTaskCmd
    
    Returns:
    
    the total number of records present in the database for the current criteria.
  - getRecordSetReferenceId
```
public java.lang.String getRecordSetReferenceId()
```
    Not supported
    
    Specified by:
    
    getRecordSetReferenceId in interface ComposeCatalogGroupTaskCmd
    
    Returns:
    
    null

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

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

Methods inherited from class java.lang.Object

ComposeCatalogGroupAllChildrenTaskCmdImpl

getCatalogGroup

execute

isReadyToCallExecute

reset

setPagingParams

setCatalogGroups

getRecordSetCompleteIndicator

getRecordSetCount

getRecordSetStartNumber

getRecordSetTotal

getRecordSetReferenceId