CatalogWS Interface

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

public interface CatalogWS

    extends Session

All Superinterfaces
BusinessSmartComponent, EJBObject, Remote, Serializable, Session

Method Summary

public String
expressionSearch(String expression)
Returns product item information populated with category and ancestor information for a search expression.
public 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.
public String
expressionSearchSKU(String expression)
Returns product item information populated with category and ancestor information for a SKU search expression.
public 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.
public String
getAllChildren(String categoryKey, boolean addAncestorInfo)
Returns an XML document of all the categories and product items under a given category.
public String
getAllChildrenRestricted(String categoryKey, boolean addAncestorInfo, int numResults)
Returns an XML document of all the categories and product items under a given category.
public String
getCategoryInfo(String productItemKey)
Returns ancestor information for all the categories a product item resides in.
public String
getRootChildren()
Returns an XML document of all the categories and product items under the root category.
public String
getRootChildrenRestricted(int numResults)
Returns an XML document of all the categories and product items under the root category.
public String
keywordSearch(String keyword)
Returns product item information populated with category and ancestor information for a set of keywords.
public 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 from interface javax.ejb.EJBObject
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove
   

Method Detail

expressionSearch(String) Method

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.

Exceptions

RemoteException

expressionSearchRestricted(String, int) Method

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.

Exceptions

RemoteException

expressionSearchSKU(String) Method

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.

Exceptions

RemoteException

expressionSearchSKURestricted(String, int) Method

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.

Exceptions

RemoteException

getAllChildren(String, boolean) Method

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.

Exceptions

RemoteException

getAllChildrenRestricted(String, boolean, int) Method

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.

Exceptions

RemoteException

getCategoryInfo(String) Method

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.

Exceptions

RemoteException

getRootChildren() Method

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.

Exceptions

RemoteException

getRootChildrenRestricted(int) Method

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.

Exceptions

RemoteException

keywordSearch(String) Method

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.

Exceptions

RemoteException

keywordSearchRestricted(String, int) Method

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.

Exceptions

RemoteException