com.ibm.commerce.catalog.facade.client

Class AbstractCatalogEntryFacadeClient

java.lang.Object

com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

com.ibm.commerce.catalog.facade.client.AbstractCatalogFacadeClient

com.ibm.commerce.catalog.facade.client.AbstractCatalogEntryFacadeClient

Deprecated.

in version 6.0, replaced by AbstractCatalogFacadeClient

public abstract class AbstractCatalogEntryFacadeClient
extends AbstractCatalogFacadeClient

Field Summary

Fields inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

CHANGE_VERB_ACTION_ADD, CHANGE_VERB_ACTION_CHANGE, CHANGE_VERB_ACTION_CREATE, CHANGE_VERB_ACTION_DELETE, CHANGE_VERB_ACTION_UPDATE

Constructor Summary

Constructors

Constructor and Description
AbstractCatalogEntryFacadeClient() Deprecated. Creates an instance of the client to communicate with the CatalogEntry facade.
AbstractCatalogEntryFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler) Deprecated. Creates an instance of the client to communicate with the CatalogEntry facade.

Method Summary

Modifier and Type	Method and Description
java.util.Hashtable	getCatalogEntryWithPaging(java.lang.String expressionLanguage, java.lang.String expression, java.lang.String maxItems, java.lang.String refId, java.lang.String startNum) Deprecated. This method provides support for paging.
java.util.Hashtable	getCatalogGroupWithPaging(java.lang.String expressionLanguage, java.lang.String expression, java.lang.String maxItems, java.lang.String refId, java.lang.String startNum) Deprecated. This method provides support for paging.

Methods inherited from class com.ibm.commerce.catalog.facade.client.AbstractCatalogFacadeClient

changeAttributeDictionary, changeAttributeDictionaryAttribute, changeAttributeDictionaryAttributeGroup, changeCatalog, changeCatalogEntry, changeCatalogFilter, changeCatalogGroup, getAttributeDictionary, getAttributeDictionary, getAttributeDictionary, getAttributeDictionaryAttribute, getAttributeDictionaryAttribute, getAttributeDictionaryAttribute, getAttributeDictionaryAttributeGroup, getAttributeDictionaryAttributeGroup, getAttributeDictionaryAttributeGroup, getCatalog, getCatalog, getCatalog, getCatalogEntry, getCatalogEntry, getCatalogEntry, getCatalogEntryFiltering, getCatalogEntryFiltering, getCatalogEntryFiltering, getCatalogFilter, getCatalogFilter, getCatalogFilter, getCatalogGroup, getCatalogGroup, getCatalogGroup, getCatalogNavigationView, getCatalogNavigationView, getCatalogNavigationView, getKit, getKit, getKit, processAttributeDictionary, processAttributeDictionaryAttribute, processAttributeDictionaryAttributeGroup, processCatalog, processCatalogEntry, processCatalogFilter, processCatalogGroup

Methods inherited from class com.ibm.commerce.foundation.client.facade.bod.AbstractBusinessObjectDocumentFacadeClient

createActionExpression, createChangeVerb, createGetVerb, createGetVerb, createProcessVerb, createSyncVerb

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCatalogEntryFacadeClient

public AbstractCatalogEntryFacadeClient()

Deprecated.

Creates an instance of the client to communicate with the CatalogEntry facade.

AbstractCatalogEntryFacadeClient

public AbstractCatalogEntryFacadeClient(BusinessContextType businessContext,
                                        javax.security.auth.callback.CallbackHandler callbackHandler)

Deprecated.

Creates an instance of the client to communicate with the CatalogEntry facade.

Parameters:

businessContext - The default business context to associate with the messages when making requests.

callbackHandler - Used for authentication purposes so the controller can give the authentication information to the transport when required.

Method Detail

getCatalogEntryWithPaging

public java.util.Hashtable getCatalogEntryWithPaging(java.lang.String expressionLanguage,
                                                     java.lang.String expression,
                                                     java.lang.String maxItems,
                                                     java.lang.String refId,
                                                     java.lang.String startNum)
                                              throws CatalogEntryException

Deprecated.

This method provides support for paging. Look at the returned hashtable description to see how paging values are passed back. Look at the parameters to be supplied for details on what paging parameters are to be passed in. It returns a list of base catalog entries based on the expression specified along with following paging parameters:

Parameters:

expressionLanguage - The expression language.

expression - The expression to return a list of base catalog entries.

maxItems - Specifies max no of records to be retrieved.

refId - The internal identifier for the result set, so that it can be resolved on a subsequent request.

startNum - The starting index from which to retrieve results from the result set

Returns:

Returns a Hashtable containing the list of catalog entries that matches the expression specified and paging parameters. Following keys are used in the Hashtable:

• 'response' - Used to store List containing Catalog Entries.
• 'recordCount' - The number of records from the result set that are being returned in this message.
• 'refId' - The internal identifier for the result set, so that it can be resolved on a subsequent request.
• 'startNumber' - The starting index for the results that are being returned in this message.
• 'totalRecords' - The total number of results in the result set.

Throws:

CatalogEntryException

getCatalogGroupWithPaging

public java.util.Hashtable getCatalogGroupWithPaging(java.lang.String expressionLanguage,
                                                     java.lang.String expression,
                                                     java.lang.String maxItems,
                                                     java.lang.String refId,
                                                     java.lang.String startNum)
                                              throws CatalogGroupException

Deprecated.

This method provides support for paging. Look at the returned hashtable description to see how paging values are passed back. Look at the parameters to be supplied for details on what paging parameters are to be passed in. It returns a list of base catalog groups based on the expression specified along with following paging parameters:

Parameters:

expressionLanguage - The expression language.

expression - The expression to return a list of base catalog groups.

maxItems - Specifies max no of records to be retrieved.

refId - The internal identifier for the result set, so that it can be resolved on a subsequent request.

startNum - The starting index from which to retrieve results from the result set

Returns:

Returns a Hashtable containing the list of catalog groups that matches the expression specified and paging parameters. Following keys are used in the Hashtable:

• 'response' - Used to store List containing Catalog Groups.
• 'recordCount' - The number of records from the result set that are being returned in this message.
• 'refId' - The internal identifier for the result set, so that it can be resolved on a subsequent request.
• 'startNumber' - The starting index for the results that are being returned in this message.
• 'totalRecords' - The total number of results in the result set.

Throws:

CatalogGroupException