Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2003 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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

All Superinterfaces:
  BusinessSmartComponent, EJBObject, Remote, Serializable, Session

public interface CatalogWS
extends Session

Method Summary
`String` | `expressionSearch(String expression)` Returns product item information populated with category and ancestor information for a search expression.
`String` | `expressionSearchRestricted(String expression, int numResults)` Returns product item information populated with category and ancestor information for a search expression for the first `numResults` results.
`String` | `expressionSearchSKU(String expression)` Returns product item information populated with category and ancestor information for a SKU search expression.
`String` | `expressionSearchSKURestricted(String expression, int numResults)` Returns product item information populated with category and ancestor information for a SKU search expression for the first `numResults` results.
`String` | `getAllChildren(String categoryKey, boolean addAncestorInfo)` Returns an XML document of all the categories and product items under a given category.
`String` | `getAllChildrenRestricted(String categoryKey, boolean addAncestorInfo, int numResults)` Returns an XML document of all the categories and product items under a given category.
`String` | `getCategoryInfo(String productItemKey)` Returns ancestor information for all the categories a product item resides in.
`String` | `getRootChildren()` Returns an XML document of all the categories and product items under the root category.
`String` | `getRootChildrenRestricted(int numResults)` Returns an XML document of all the categories and product items under the root category.
`String` | `keywordSearch(String keyword)` Returns product item information populated with category and ancestor information for a set of keywords.
`String` | `keywordSearchRestricted(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 String getAllChildren(String categoryKey,
                                 boolean addAncestorInfo)
                          throws 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.
    `RemoteException`

### getAllChildrenRestricted

    public String getAllChildrenRestricted(String categoryKey,
                                           boolean addAncestorInfo,
                                           int numResults)
                                    throws 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.
    `RemoteException`

### getRootChildren

    public String getRootChildren()
                           throws 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.
    `RemoteException`

### getRootChildrenRestricted

    public String getRootChildrenRestricted(int numResults)
                                     throws 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.
    `RemoteException`

### getCategoryInfo

    public String getCategoryInfo(String productItemKey)
                           throws 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.
    `RemoteException`

### keywordSearch

    public String keywordSearch(String keyword)
                         throws 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.
    `RemoteException`

### keywordSearchRestricted

    public String keywordSearchRestricted(String keyword,
                                          int numResults)
                                   throws 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.
    `RemoteException`

### expressionSearch

    public String expressionSearch(String expression)
                            throws 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.
    `RemoteException`

### expressionSearchRestricted

    public String expressionSearchRestricted(String expression,
                                             int numResults)
                                      throws 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.
    `RemoteException`

### expressionSearchSKU

    public String expressionSearchSKU(String expression)
                               throws 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.
    `RemoteException`

### expressionSearchSKURestricted

    public String expressionSearchSKURestricted(String expression,
                                                int numResults)
                                         throws 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.
    `RemoteException`

Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2003 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2003 BEA Systems, Inc. All Rights Reserved