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

Class GetCatalogCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.foundation.server.command.bod.AbstractGetBusinessObjectDocumentCmdImpl

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

All Implemented Interfaces:

GetCatalogCmd, BusinessObjectDocumentCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

public class GetCatalogCmdImpl
extends AbstractGetBusinessObjectDocumentCmdImpl
implements GetCatalogCmd

This class is the implementation class for the get catalog service. This contains methods to set the get request and obtain the show response which contains the Catalog details. This class initializes and executes the right catalog fetch command based on the XPath key, in the get request. The validateExpression() method can be overridden to do any custom validation on the Xpath.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

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

serialVersionUID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ShowCatalogType	createExceptionInShowCatalog(java.lang.Exception exception) This method will set the exception as the result of running the request.
ShowCatalogType	getShowCatalog() This method returns the show verb for Catalog noun.
void	setGetCatalog(GetCatalogType getCatalog) This method sets the get verb for Catalog noun.
void	setRequestBusinessObjectDocument(BusinessObjectDocumentType businessObjectDocument) Set the get request business object document.

Methods inherited from class com.ibm.commerce.foundation.server.command.bod.AbstractGetBusinessObjectDocumentCmdImpl

getFetchCommandInterface, getInsertMoreDataCommandInterface, getResultBusinessObjectDocument, getSearchExpression, getUniqueID, handleException, isReadyToCallExecute, performExecute, setFetchCommandInterface, setInsertMoreDataCommandInterface, setOutputProperties, setUniqueIDXPath

Methods inherited from class com.ibm.commerce.command.MeasuredCacheableCommandImpl

execute

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getObjectSize, getSharingPolicy, postExecute, preExecute, reset, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

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

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

execute, reset

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName

Constructor Detail

GetCatalogCmdImpl

public GetCatalogCmdImpl()

This constructor calls the constructor of super class.

Method Detail

setGetCatalog

public void setGetCatalog(GetCatalogType getCatalog)

This method sets the get verb for Catalog noun.

Specified by:

setGetCatalog in interface GetCatalogCmd

Parameters:

getCatalog - It is of type GetCatalogType.

getShowCatalog

public ShowCatalogType getShowCatalog()

This method returns the show verb for Catalog noun.

Specified by:

getShowCatalog in interface GetCatalogCmd

Returns:

Returns an object of type ShowCatalogType.

createExceptionInShowCatalog

public ShowCatalogType createExceptionInShowCatalog(java.lang.Exception exception)

This method will set the exception as the result of running the request. The command implementation will use this call out method to populate the response business object document with the exception information. Although the getResultBusinessObjectDocument() will still be used to return the result, this call out will indicate that exception information is required to be populated.

Parameters:

exception - The application exception that occurred when running the business object document.

Returns:

the object of ShowCatalogType.

setRequestBusinessObjectDocument

public void setRequestBusinessObjectDocument(BusinessObjectDocumentType businessObjectDocument)

Set the get request business object document.

Specified by:

setRequestBusinessObjectDocument in interface BusinessObjectDocumentCmd

Overrides:

setRequestBusinessObjectDocument in class AbstractGetBusinessObjectDocumentCmdImpl

Parameters:

businessObjectDocument - The request business object document.

See Also:

BusinessObjectDocumentCmd.setRequestBusinessObjectDocument(com.ibm.commerce.oagis9.datatypes.BusinessObjectDocumentType)