# com.beasys.commerce.ebusiness.catalog.webservice
CatalogWSImpl Class

public class CatalogWSImpl
extends `SessionImpl`

Hierarchy
  `Object`
  `SessionImpl`
  `CatalogWSImpl`

All Implemented Interfaces
  `EnterpriseBean`, `Serializable`, `SessionBean`

## Field Summary

Fields from com.beasys.commerce.foundation`.`SessionImpl``
``_ctx`, `_environmentNamingContext`, `_environmentPropertyCache`, `_isDirty``

## Constructor Summary

CatalogWSImpl()

## Method Summary

`public void` | `ejbActivate`() ejbActivate method.
`public void` | `ejbCreate`() ejbCreate method.
`public void` | `ejbPassivate`() ejbPassivate method.
`public void` | `ejbPostCreate`() ejbPostCreate method.
`public void` | `ejbRemove`() ejbRemove method.
`public `String`` | `expressionSearch`(`String` expression) Returns product item information populated with category and ancestor information for a search expression for the first 100 results.
`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 the first 100 categories and 100 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 the first 100 categories and 100 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 for the first 100 results.
`public `String`` | `keywordSearchRestricted`(`String` keywords, int numResults) Returns product item information populated with category and ancestor information for a set of keywords for the first `numResults` results.
`public void` | `setSessionContext`(`SessionContext` ctx) setSessionContext method.

Methods from `com.beasys.commerce.foundation.`SessionImpl``
``clearRelationalBinding`, `clearRelationalBinding`, `clearRelationalBinding`, `clearRelationalBinding`, `doRelationalBinding`, `doRelationalBinding`, `doRelationalBindingOnElement`, `doRelationalBindingOnElement`, `doRelationalBindingOnElement`, `doRelationalBindingOnSingleton`, `doRelationalBindingOnSingleton`, `doRelationalBindingOnSingleton`, `doRelationalBindingWithMapKey`, `doRelationalBindingWithMapKey`, `doRelationalBindingWithMapKey`, `enumerateRelationalBinding`, `enumerateRelationalBinding`, `getEnvironmentNamingContext`, `getEnvironmentProperty`, `getEnvironmentProperty`, `getEnvironmentPropertyCache`, `getPersistenceHelperPlugin`, `getSessionContext`,`

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods from interface `javax.ejb.`SessionBean``
`ejbActivate, ejbPassivate, ejbRemove, setSessionContext`

## Constructor Detail

### CatalogWSImpl

    public CatalogWSImpl()

## Method Detail

### ejbActivate() Method

    public void ejbActivate()
         throws EJBException

Description copied from `SessionImpl.ejbActivate()`
ejbActivate method.

Overrides
  `SessionImpl.ejbActivate()`

#### Exceptions

``EJBException``

### ejbCreate() Method

    public void ejbCreate()
         throws CreateException

Description copied from `SessionImpl.ejbCreate()`
ejbCreate method.

Overrides
  `SessionImpl.ejbCreate()`

#### Exceptions

``CreateException``

### ejbPassivate() Method

    public void ejbPassivate()
         throws EJBException

Description copied from `SessionImpl.ejbPassivate()`
ejbPassivate method.

Overrides
  `SessionImpl.ejbPassivate()`

#### Exceptions

``EJBException``

### ejbPostCreate() Method

    public void ejbPostCreate()
         throws CreateException

Description copied from `SessionImpl.ejbPostCreate()`
ejbPostCreate method.

Overrides
  `SessionImpl.ejbPostCreate()`

#### Exceptions

``CreateException``

### ejbRemove() Method

    public void ejbRemove()
         throws EJBException

Description copied from `SessionImpl.ejbRemove()`
ejbRemove method.

Overrides
  `SessionImpl.ejbRemove()`

#### Exceptions

``EJBException``

### expressionSearch(String) Method

    public String expressionSearch(String expression)
         throws RemoteException

Returns product item information populated with category and ancestor information for a search expression for the first 100 results.

#### 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 the first 100 categories and 100 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 of categories and product items.

#### 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 the first 100 categories and 100 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` categories and product items .

#### 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 for the first 100 results.

#### Parameters

keyword
  Search keyword(s).

#### Returns

XML Document of all information.

#### Exceptions

``RemoteException``

### keywordSearchRestricted(String, int) Method

    public String keywordSearchRestricted(String keywords,
                                          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

keywords
  Search keyword(s).

numResults
  number of results to be returned.

#### Returns

XML Document of all information.

#### Exceptions

``RemoteException``

### setSessionContext(SessionContext) Method

    public void setSessionContext(SessionContext ctx)
         throws EJBException

Description copied from `SessionImpl.setSessionContext(SessionContext)`
setSessionContext method.

Overrides
  `SessionImpl.setSessionContext(SessionContext)`

#### Exceptions

``EJBException``