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

Class AbstractFetchCatalogSOICmdImpl

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

FetchCatalogByCatalogIdCmdImpl, FetchCatalogByIdentifierTaskCmdImpl, FetchCatalogByStoreIdCmdImpl

public abstract class AbstractFetchCatalogSOICmdImpl
extends java.lang.Object
implements FetchCatalogCmd

This class calls the appropriate Fetch and compose catalog commands, based on the XPath key and the access profile respectively. Access control for this command is based on the access control for the command com.ibm.commerce.catalog.commands.StoreCatalogDisplayCmd. That is the user who has the access to run StoreCatalogDisplayCmd will be able to run this command.

See Also:

Serialized Form

Field Summary

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AbstractFetchCatalogSOICmdImpl() The default constructor for the class.

Method Summary

Modifier and Type	Method and Description
void	execute() This method is used to call the appropriate fetch method based on the Xpath key.
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.
ShowType	getShow() Get the show type.
ShowCatalogDataAreaType	getShowCatalogDataArea()
boolean	isReadyToCallExecute()
void	reset() Resets the command fields, so that the getSelectionCriteriaMapper() and getShowCatalogDataArea() return null.
void	setGet(GetType getVerb) This method sets the get expression for the fetch operation.
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

AbstractFetchCatalogSOICmdImpl

public AbstractFetchCatalogSOICmdImpl()

The default constructor for the class.

Method Detail

getLogger

public java.util.logging.Logger getLogger()

Returns:

The Logger for the class.

getShowCatalogDataArea

public ShowCatalogDataAreaType getShowCatalogDataArea()

Returns:

the ShowCatalogDataAreaType containing the all the Catalog information to be displayed.

execute

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

This method is used to call the appropriate fetch method based on the Xpath key. The compose command is instantiated from 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

isReadyToCallExecute

public boolean isReadyToCallExecute()

Specified by:

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

Returns:

true if ready, false otherwise.

reset

public void reset()

Resets the command fields, so that the getSelectionCriteriaMapper() and getShowCatalogDataArea() return null.

Specified by:

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

setGet

public void setGet(GetType getVerb)

This method sets the get expression for the fetch operation. This get expression can also include the paging information to base the results to show.

Specified by:

setGet in interface FetchCatalogCmd

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.

getShow

public ShowType getShow()

Get the show type.

Specified by:

getShow in interface FetchCatalogCmd

Specified by:

getShow in interface AbstractFetchNounCmd

Returns:

The show verb that corresponds with the results returned.

See Also:

AbstractFetchNounCmd.getShow()

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 FetchCatalogCmdImpl. 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.