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

Class AbstractFetchCatalogEntrySOICmdImpl

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

FetchCatalogEntriesForCategoryTaskCmdImpl, FetchCatalogEntryByCatEntryIdTaskCmdImpl, FetchCatalogEntryByPartNumberTaskCmdImpl, FetchCatalogEntryBySearchTaskCmdImpl, FetchChildrenCatentriesOfCategoryTaskCmdImpl

public abstract class AbstractFetchCatalogEntrySOICmdImpl
extends java.lang.Object
implements FetchCatalogEntryCmd

This abstract command class is used to call correct implementation of Fetch. and Compose commands based on selection criteria passed by client.

See Also:

Serialized Form

Field Summary

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AbstractFetchCatalogEntrySOICmdImpl() This constructor calls the constructor of super class.

Method Summary

Modifier and Type	Method and Description
void	execute() The method contains the actual business logic of this command.
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.
ShowCatalogEntryDataAreaType	getShowCatalogEntryDataArea() This method retrieves the data area of Catalog Entry BOD.
boolean	isReadyToCallExecute() Checks if GetVerb is not null.
void	reset() Initializes objects of SelectionCriteriaMapper and ShowCatalogEntryDataArea to 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

AbstractFetchCatalogEntrySOICmdImpl

public AbstractFetchCatalogEntrySOICmdImpl()

This constructor calls the constructor of super class.

Method Detail

getShowCatalogEntryDataArea

public ShowCatalogEntryDataAreaType getShowCatalogEntryDataArea()

This method retrieves the data area of Catalog Entry BOD.

Returns:

Returns an object of type ShowCatalogEntryDataAreaType.

execute

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

The method contains the actual business logic of this command. SelectionCriteriaMapper is used to parse query parameters, xpath key and access profile(s) from the OAGIS GET verb selection criteria expression. CommandFactory is used to map the xpath key to fetch task command implementation. After mapping it creates an instance of the command and runs it. CMDREG table is used to resolve these mappings. Based on the xpath key the concrete implementation of fetch task command is called. Based on the access profile this method calls compose task command implementation.

Specified by:

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

Throws:

com.ibm.websphere.command.CommandException - This exception is raised when a command key is not present in the command registry.

CatalogSystemException - This exception is raised if GetType verb is null or Access profile is null.

isReadyToCallExecute

public boolean isReadyToCallExecute()

Checks if GetVerb is not null.

Specified by:

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

Returns:

Returns true if GetVerb is not null otherwise returns false.

reset

public void reset()

Initializes objects of SelectionCriteriaMapper and ShowCatalogEntryDataArea to 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 FetchCatalogEntryCmd

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 FetchCatalogEntryCmd

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