© 2002 BEA Systems, Inc.


com.beasys.commerce.ebusiness.catalog.webservice
Interface CatalogWS


public interface CatalogWS
extends Session


Method Summary
 java.lang.String expressionSearch(java.lang.String expression)
          Returns product item information populated with category and ancestor information for a search expression.
 java.lang.String expressionSearchRestricted(java.lang.String expression, int numResults)
          Returns product item information populated with category and ancestor information for a search expression for the first numResults results.
 java.lang.String expressionSearchSKU(java.lang.String expression)
          Returns product item information populated with category and ancestor information for a SKU search expression.
 java.lang.String expressionSearchSKURestricted(java.lang.String expression, int numResults)
          Returns product item information populated with category and ancestor information for a SKU search expression for the first numResults results.
 java.lang.String getAllChildren(java.lang.String categoryKey, boolean addAncestorInfo)
          Returns an XML document of all the categories and product items under a given category.
 java.lang.String getAllChildrenRestricted(java.lang.String categoryKey, boolean addAncestorInfo, int numResults)
          Returns an XML document of all the categories and product items under a given category.
 java.lang.String getCategoryInfo(java.lang.String productItemKey)
          Returns ancestor information for all the categories a product item resides in.
 java.lang.String getRootChildren()
          Returns an XML document of all the categories and product items under the root category.
 java.lang.String getRootChildrenRestricted(int numResults)
          Returns an XML document of all the categories and product items under the root category.
 java.lang.String keywordSearch(java.lang.String keyword)
          Returns product item information populated with category and ancestor information for a set of keywords.
 java.lang.String keywordSearchRestricted(java.lang.String keyword, int numResults)
          Returns product item information populated with category and ancestor information for a set of keywords for the first numResults results.
 
Methods inherited from interface javax.ejb.EJBObject
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove
 

Method Detail

getAllChildren

public java.lang.String getAllChildren(java.lang.String categoryKey,
                                       boolean addAncestorInfo)
                                throws java.rmi.RemoteException
Returns an XML document of all the categories and product items under a given category. The category is identified by a string category key.

Parameters:
categoryKey - String representation of category key concerned.
addAncestorInfo - if true adds ancestor info to the category children.
Returns:
XML Document of categories and product items under categoryKey.

getAllChildrenRestricted

public java.lang.String getAllChildrenRestricted(java.lang.String categoryKey,
                                                 boolean addAncestorInfo,
                                                 int numResults)
                                          throws java.rmi.RemoteException
Returns an XML document of all the categories and product items under a given category. The category is identified by a string category key. This call restricts the number of results to a specified number.

Parameters:
categoryKey - String representation of category key concerned.
addAncestorInfo - if true adds ancestor info to the category children.
numResults - number of results to be returned
Returns:
XML Document of categories and product items under categoryKey.

getRootChildren

public java.lang.String getRootChildren()
                                 throws java.rmi.RemoteException
Returns an XML document of all the categories and product items under the root category.

Returns:
XML Document of categories and product items under categoryKey.

getRootChildrenRestricted

public java.lang.String getRootChildrenRestricted(int numResults)
                                           throws java.rmi.RemoteException
Returns an XML document of all the categories and product items under the root category. Restricts the number of results to the first numResults.

Parameters:
numResults - number of results to be returned.
Returns:
XML Document of categories and product items under categoryKey.

getCategoryInfo

public java.lang.String getCategoryInfo(java.lang.String productItemKey)
                                 throws java.rmi.RemoteException
Returns ancestor information for all the categories a product item resides in.

Parameters:
productItemKey - String representation of product item key concerned.
Returns:
XML Document of category information.

keywordSearch

public java.lang.String keywordSearch(java.lang.String keyword)
                               throws java.rmi.RemoteException
Returns product item information populated with category and ancestor information for a set of keywords.

Parameters:
keyword - Search keyword(s).
Returns:
XML Document of all information.

keywordSearchRestricted

public java.lang.String keywordSearchRestricted(java.lang.String keyword,
                                                int numResults)
                                         throws java.rmi.RemoteException
Returns product item information populated with category and ancestor information for a set of keywords for the first numResults results.

Parameters:
keyword - Search keyword(s).
numResults - number of results to be returned.
Returns:
XML Document of all information.

expressionSearch

public java.lang.String expressionSearch(java.lang.String expression)
                                  throws java.rmi.RemoteException
Returns product item information populated with category and ancestor information for a search expression.

Parameters:
expression - Search expression.
Returns:
XML string of all information.

expressionSearchRestricted

public java.lang.String expressionSearchRestricted(java.lang.String expression,
                                                   int numResults)
                                            throws java.rmi.RemoteException
Returns product item information populated with category and ancestor information for a search expression for the first numResults results.

Parameters:
expression - Search expression.
numResults - number of results to be returned.
Returns:
XML string of all information.

expressionSearchSKU

public java.lang.String expressionSearchSKU(java.lang.String expression)
                                     throws java.rmi.RemoteException
Returns product item information populated with category and ancestor information for a SKU search expression.

Parameters:
expression - SKU Search expression.
Returns:
XML string of all information.

expressionSearchSKURestricted

public java.lang.String expressionSearchSKURestricted(java.lang.String expression,
                                                      int numResults)
                                               throws java.rmi.RemoteException
Returns product item information populated with category and ancestor information for a SKU search expression for the first numResults results.

Parameters:
expression - SKU Search expression.
numResults - number of results to be returned.
Returns:
XML string of all information.

© 2002 BEA Systems, Inc.

Copyright © 2002 BEA Systems, Inc. All Rights Reserved