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

Class AbstractFetchCatalogGroupSOICmdImpl

java.lang.Object

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

All Implemented Interfaces:

FetchCatalogGroupCmd, AbstractFetchNounCmd, com.ibm.websphere.command.Command, java.io.Serializable

Direct Known Subclasses:

FetchCatalogGroupByIdentifierTaskCmdImpl, FetchCatalogGroupByIdTaskCmdImpl, FetchChildrenCategoriesOfCategoryTaskCmdImpl, FetchParentCategoriesForCategoryTaskCmdImpl, FetchTopCategoriesTaskCmdImpl

public abstract class AbstractFetchCatalogGroupSOICmdImpl
extends java.lang.Object
implements FetchCatalogGroupCmd

This class calls the appropriate Fetch and compose category commands, based on the XPath key and the access profile respectively. Access control is based on the access control for the command com.ibm.commerce.catalog.commands.CategoryDisplayCmd.

See Also:

Serialized Form

Field Summary

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AbstractFetchCatalogGroupSOICmdImpl() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	execute() This method fetches the required catalog group based on the XPath key and calls the appropriate compose command based on the access profile requested.
java.math.BigInteger	getBeginIndex()
java.math.BigInteger	getDisplayNum()
java.util.logging.Logger	getLogger()
java.util.List	getNouns() This method returns the list of nouns that have been retrieved by the business object manager that matches the specified XPath expression.
boolean	getRecordSetCompleteIndicator()
java.math.BigInteger	getRecordSetCount() This method returns the total count of records that are being returned by the fetch command.
java.lang.String	getRecordSetReferenceId() Not supported.
java.math.BigInteger	getRecordSetStartNumber()
java.math.BigInteger	getRecordSetTotal() This method returns the total number of records present for the input selection criteria.
ShowType	getShow() This method returns the show verb response that represent the results of the fetch operation.
ShowCatalogGroupDataAreaType	getShowCatalogGroupDataArea()
boolean	isReadyToCallExecute() This method checks if the Fetch command has the required fields set to run.
void	reset() Resets the command fields.
void	setGet(GetType getVerb) This method sets the get expression for the fetch operation.
void	setPagingParameters(java.math.BigInteger begIndex, java.math.BigInteger dispNum)
void	setRecordSetCompleteIndicator(boolean flag)
void	setRecordSetCount(java.math.BigInteger count) This method is used to set the total count of records that are to be returned by the fetch command.
void	setRecordSetReferenceId(java.lang.String id) Not supported.
void	setRecordSetStartNumber(java.math.BigInteger startNumber)
void	setRecordSetTotal(java.math.BigInteger total) This method sets the total number of records present for the current selection criteria.
void	setSearchExpression(SearchExpression searchExpression) Set the search expression.
void	setVersionCheck(java.lang.String versionCheck) This method sets whether the implementation is dependent on whether the version is found in the business object document request.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFetchCatalogGroupSOICmdImpl

public AbstractFetchCatalogGroupSOICmdImpl()

Default constructor.

Method Detail

getLogger

public java.util.logging.Logger getLogger()

Returns:

The Logger for the class.

execute

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

This method fetches the required catalog group based on the XPath key and calls the appropriate compose command based on the access profile requested. The right compose command to be instantiated is looked up for in the CommandFactory, using the access profile key passed. The access profile key passed can be acquired from the instance of com.ibm.commerce.foundation.server.util.oagis.SelectionCriteriaMapper, which can be obtained by the getSelectionCriteriaMapper() method.

Specified by:

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

Throws:

CommandException, - when a runtime exception is caught.

CatalogSystemException, - when the Required parameters are not set or the compose command is not found.

com.ibm.websphere.command.CommandException

CatalogSystemException

getBeginIndex

public java.math.BigInteger getBeginIndex()

Returns:

the beginning index for paging. This parameter determines the page number by specifying the start number for the index.

getDisplayNum

public java.math.BigInteger getDisplayNum()

Returns:

the display number for paging. This parameter determines the page size.

isReadyToCallExecute

public boolean isReadyToCallExecute()

This method checks if the Fetch command has the required fields set to run.

Specified by:

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

Returns:

true if ready, false otherwise.

reset

public void reset()

Resets the command fields. This method resets the fields of the fetch command such that, getSelectionCriteriaMapper() and getShowCatalogGroupDataArea() return null values.

Specified by:

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

getShowCatalogGroupDataArea

public ShowCatalogGroupDataAreaType getShowCatalogGroupDataArea()

Returns:

the ShowCatalogGroupDataAreaType which contains all the category information to be displayed.

setPagingParameters

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

Parameters:

begIndex - the beginning index.

dispNum - the page size.

getRecordSetCompleteIndicator

public boolean getRecordSetCompleteIndicator()

Returns:

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

getRecordSetCount

public java.math.BigInteger getRecordSetCount()

This method returns the total count of records that are being returned by the fetch command. This can be less than or equal to the page size requested.

Returns:

The total count of records.

getRecordSetStartNumber

public java.math.BigInteger getRecordSetStartNumber()

Returns:

the starting index.

getRecordSetTotal

public java.math.BigInteger getRecordSetTotal()

This method returns the total number of records present for the input selection criteria. This can be used to determine the total number of pages that will be needed to display catalog groups based on the current selection criteria.

Returns:

the total number of records.

getRecordSetReferenceId

public java.lang.String getRecordSetReferenceId()

Not supported.

Returns:

The reference ID. Returns a null value.

setRecordSetCompleteIndicator

public void setRecordSetCompleteIndicator(boolean flag)

Parameters:

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

setRecordSetCount

public void setRecordSetCount(java.math.BigInteger count)

This method is used to set the total count of records that are to be returned by the fetch command. This count is the number of records to be displayed in each page.

Parameters:

count - - The total count of records.

setRecordSetStartNumber

public void setRecordSetStartNumber(java.math.BigInteger startNumber)

Parameters:

startNumber - - the starting index.

setRecordSetTotal

public void setRecordSetTotal(java.math.BigInteger total)

This method sets the total number of records present for the current selection criteria. This can be used to determine the number of pages to be displayed.

Parameters:

total - - the total number of records.

setRecordSetReferenceId

public void setRecordSetReferenceId(java.lang.String id)

Not supported.

Parameters:

id - - The reference ID. The passed value is ignored.

getShow

public ShowType getShow()

This method returns the show verb response that represent the results of the fetch operation. The showVerb returned contains the details of the records returned as a result of the fetch command for the requested access profile, if the method is called after the successful running of exceute().

Specified by:

getShow in interface FetchCatalogGroupCmd

Specified by:

getShow in interface AbstractFetchNounCmd

Returns:

The show verb response.

See Also:

FetchCatalogCmd.getShow()

setGet

public void setGet(GetType getVerb)

This method sets the get expression for the fetch operation. The get expression will contain the details of the xpath request. The get expression also can contain the paging parameters.

Specified by:

setGet in interface FetchCatalogGroupCmd

Specified by:

setGet in interface AbstractFetchNounCmd

Parameters:

getVerb - The get expression.

See Also:

FetchCatalogCmd.setGet(com.ibm.commerce.oagis9.datatypes.GetType)

setSearchExpression

public void setSearchExpression(SearchExpression searchExpression)

Set the search expression.

Specified by:

setSearchExpression in interface AbstractFetchNounCmd

Parameters:

searchExpression - The search expression to execute.

See Also:

AbstractFetchNounCmd.setSearchExpression(com.ibm.commerce.foundation.server.command.bod.SearchExpression)

getNouns

public java.util.List getNouns()

This method returns the list of nouns that have been retrieved by the business object manager that matches the specified XPath expression.

Specified by:

getNouns in interface AbstractFetchNounCmd

Returns:

The list of nouns that represent the XPath expression.

setVersionCheck

public void setVersionCheck(java.lang.String versionCheck)

This method sets whether the implementation is dependent on whether the version is found in the business object document request. A verion of null with use this implementation and a none null version will use the FetchCatalogGroupCmdImpl. The default behaviour is to perform this decision process of selecting which implementation to use.

Parameters:

versionCheck - Whether this version check needs to be enforced. A value of false means that this implementation will be used regardless if the version is specified in the business object document.