CatalogSearchDataBean

java.lang.Object
- com.ibm.commerce.tools.campaigns.CatalogSearchDataBean

All Implemented Interfaces:

java.io.Serializable
```
public class CatalogSearchDataBean
extends java.lang.Object
implements java.io.Serializable
```
This data bean represents each row in the catalog search result list. All the data associated with the catalog search result is being retrieved either by getting the value from the list data bean, or in this data bean using the lazy fetch method.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.

Constructor Summary

Constructors
Constructor and Description

CatalogSearchDataBean()
Constructor for CatalogSearchDataBean.

Constructors
Constructor and Description
`CatalogSearchDataBean()` Constructor for CatalogSearchDataBean.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getCatalogId()` Gets the ID of the catalog the category/catalog entry belongs to.
`java.lang.String`	`getCatalogIdentifier()` Gets the identifier of the catalog the category/catalog entry belongs to.
`java.lang.String`	`getCatalogMemberId()` Gets the member ID of the catalog the category/catalog entry belongs to.
`com.ibm.commerce.command.CommandContext`	`getCommandContext()` Gets the current command context that is used to retrieve the runtime attribute like the store ID and the member ID.
`java.lang.String`	`getEncodedIdentifier()` Gets the url-encoded identifier of the category/catalog entry.
`java.lang.String`	`getId()` Gets the ID of the category/catalog entry.
`java.lang.String`	`getIdentifier()` Gets the identifier of the category/catalog entry.
`java.lang.String`	`getLanguageId()` Gets the language ID that is currently being used.
`java.lang.String`	`getMemberId()` Gets the member ID of the category/catalog entry.
`java.lang.String`	`getName()` Gets the name of the category/catalog entry.
`java.lang.String`	`getParentId()` Gets the ID of the parent category that this category belongs to.
`java.lang.String`	`getParentIdentifier()` Gets the identifier of the parent category that this category belongs to.
`java.lang.String`	`getParentName()` Gets the name of the parent category that this category belongs to.
`java.lang.String`	`getShortDescription()` Gets the short description of the category/catalog entry.
`java.lang.String`	`getStoreId()` Gets the ID of the store that is currently logged on to.
`java.lang.String`	`getType()` Gets the type of the category/catalog entry.
`void`	`populate()` Populates the data bean.
`void`	`setCatalogId(java.lang.String newCatalogId)` Sets the ID of the catalog the category/catalog entry belongs to.
`void`	`setCatalogIdentifier(java.lang.String newCatalogIdentifier)` Sets the identifier of the catalog the category/catalog entry belongs to.
`void`	`setCatalogMemberId(java.lang.String newCatalogMemberId)` Sets the member ID of the catalog the category/catalog entry belongs to.
`void`	`setCommandContext(com.ibm.commerce.command.CommandContext newCommandContext)` Sets the current command context that is used to retrieve the runtime attribute like the store ID and the member ID.
`void`	`setId(java.lang.String newId)` Sets the ID of the category/catalog entry.
`void`	`setIdentifier(java.lang.String newIdentifier)` Sets the identifier of the category/catalog entry.
`void`	`setLanguageId(java.lang.String newLanguageId)` Sets the language ID that is currently being used.
`void`	`setMemberId(java.lang.String newMemberId)` Sets the member ID of the category/catalog entry.
`void`	`setName(java.lang.String newName)` Sets the name of the category/catalog entry.
`void`	`setParentId(java.lang.String newParentId)` Sets the ID of the parent category that this category belongs to.
`void`	`setParentIdentifier(java.lang.String newParentIdentifier)` Sets the identifier of the parent category that this category belongs to.
`void`	`setParentName(java.lang.String newParentName)` Sets the name of the parent category that this category belongs to.
`void`	`setShortDescription(java.lang.String newShortDescription)` Sets the short description of the category/catalog entry.
`void`	`setStoreId(java.lang.String newStoreId)` Sets the ID of the store that is currently logged on to.
`void`	`setType(java.lang.String newType)` Sets the type of the category/catalog entry.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CatalogSearchDataBean
```
public CatalogSearchDataBean()
```
    Constructor for CatalogSearchDataBean.
- Method Detail
  - getCatalogId
```
public java.lang.String getCatalogId()
```
    Gets the ID of the catalog the category/catalog entry belongs to.
    
    Returns:
    
    The catalog ID.
  - getCatalogIdentifier
```
public java.lang.String getCatalogIdentifier()
```
    Gets the identifier of the catalog the category/catalog entry belongs to.
    
    Returns:
    
    The catalog identifier.
  - getCatalogMemberId
```
public java.lang.String getCatalogMemberId()
```
    Gets the member ID of the catalog the category/catalog entry belongs to.
    
    Returns:
    
    The catalog member ID.
  - getCommandContext
```
public com.ibm.commerce.command.CommandContext getCommandContext()
```
    Gets the current command context that is used to retrieve the runtime attribute like the store ID and the member ID.
    
    Returns:
    
    The current command context.
  - getEncodedIdentifier
```
public java.lang.String getEncodedIdentifier()
```
    Gets the url-encoded identifier of the category/catalog entry.
    
    Returns:
    
    Identifier of the category/catalog entry.
  - getId
```
public java.lang.String getId()
```
    Gets the ID of the category/catalog entry.
    
    Returns:
    
    ID of the category/catalog entry.
  - getIdentifier
```
public java.lang.String getIdentifier()
```
    Gets the identifier of the category/catalog entry.
    
    Returns:
    
    Identifier of the category/catalog entry.
  - getLanguageId
```
public java.lang.String getLanguageId()
```
    Gets the language ID that is currently being used.
    
    Returns:
    
    The language ID.
  - getMemberId
```
public java.lang.String getMemberId()
```
    Gets the member ID of the category/catalog entry.
    
    Returns:
    
    Member ID of the category/catalog entry.
  - getName
```
public java.lang.String getName()
```
    Gets the name of the category/catalog entry.
    
    Returns:
    
    Name of the category/catalog entry.
  - getParentId
```
public java.lang.String getParentId()
```
    Gets the ID of the parent category that this category belongs to.
    
    Returns:
    
    ID of the parent category.
  - getParentIdentifier
```
public java.lang.String getParentIdentifier()
```
    Gets the identifier of the parent category that this category belongs to.
    
    Returns:
    
    Identifier of the parent category.
  - getParentName
```
public java.lang.String getParentName()
```
    Gets the name of the parent category that this category belongs to.
    
    Returns:
    
    Name of the parent category.
  - getShortDescription
```
public java.lang.String getShortDescription()
```
    Gets the short description of the category/catalog entry.
    
    Returns:
    
    Short description of the category/catalog entry.
  - getStoreId
```
public java.lang.String getStoreId()
```
    Gets the ID of the store that is currently logged on to.
    
    Returns:
    
    The store ID.
  - getType
```
public java.lang.String getType()
```
    Gets the type of the category/catalog entry.
    
    Returns:
    
    Type of the category/catalog entry.
  - populate
```
public void populate()
```
    Populates the data bean. Since lazy fetch mechanism is used for this bean, nothing is done here.
  - setCatalogId
```
public void setCatalogId(java.lang.String newCatalogId)
```
    Sets the ID of the catalog the category/catalog entry belongs to.
    
    Parameters:
    
    newCatalogId - The catalog ID.
  - setCatalogIdentifier
```
public void setCatalogIdentifier(java.lang.String newCatalogIdentifier)
```
    Sets the identifier of the catalog the category/catalog entry belongs to.
    
    Parameters:
    
    newCatalogIdentifier - The catalog identifier.
  - setCatalogMemberId
```
public void setCatalogMemberId(java.lang.String newCatalogMemberId)
```
    Sets the member ID of the catalog the category/catalog entry belongs to.
    
    Parameters:
    
    newCatalogMemberId - The catalog member ID.
  - setCommandContext
```
public void setCommandContext(com.ibm.commerce.command.CommandContext newCommandContext)
```
    Sets the current command context that is used to retrieve the runtime attribute like the store ID and the member ID.
    
    Parameters:
    
    newCommandContext - The current command context.
  - setId
```
public void setId(java.lang.String newId)
```
    Sets the ID of the category/catalog entry.
    
    Parameters:
    
    newId - ID of the category/catalog entry.
  - setIdentifier
```
public void setIdentifier(java.lang.String newIdentifier)
```
    Sets the identifier of the category/catalog entry.
    
    Parameters:
    
    newIdentifier - Identifier of the category/catalog entry.
  - setLanguageId
```
public void setLanguageId(java.lang.String newLanguageId)
```
    Sets the language ID that is currently being used.
    
    Parameters:
    
    newLanguageId - The language ID.
  - setMemberId
```
public void setMemberId(java.lang.String newMemberId)
```
    Sets the member ID of the category/catalog entry.
    
    Parameters:
    
    newMemberId - Member ID of the category/catalog entry.
  - setName
```
public void setName(java.lang.String newName)
```
    Sets the name of the category/catalog entry.
    
    Parameters:
    
    newName - Name of the category/catalog entry.
  - setParentId
```
public void setParentId(java.lang.String newParentId)
```
    Sets the ID of the parent category that this category belongs to.
    
    Parameters:
    
    newParentId - ID of the parent category.
  - setParentIdentifier
```
public void setParentIdentifier(java.lang.String newParentIdentifier)
```
    Sets the identifier of the parent category that this category belongs to.
    
    Parameters:
    
    newParentIdentifier - Identifier of the parent category.
  - setParentName
```
public void setParentName(java.lang.String newParentName)
```
    Sets the name of the parent category that this category belongs to.
    
    Parameters:
    
    newParentName - Name of the parent category.
  - setShortDescription
```
public void setShortDescription(java.lang.String newShortDescription)
```
    Sets the short description of the category/catalog entry.
    
    Parameters:
    
    newShortDescription - Short description of the category/catalog entry.
  - setStoreId
```
public void setStoreId(java.lang.String newStoreId)
```
    Sets the ID of the store that is currently logged on to.
    
    Parameters:
    
    newStoreId - The store ID.
  - setType
```
public void setType(java.lang.String newType)
```
    Sets the type of the category/catalog entry.
    
    Parameters:
    
    newType - Type of the category/catalog entry.

Methods inherited from class java.lang.Object

COPYRIGHT

CatalogSearchDataBean

getCatalogId

getCatalogIdentifier

getCatalogMemberId

getCommandContext

getEncodedIdentifier

getId

getIdentifier

getLanguageId

getMemberId

getName

getParentId

getParentIdentifier

getParentName

getShortDescription

getStoreId

getType

populate

setCatalogId

setCatalogIdentifier

setCatalogMemberId

setCommandContext

setId

setIdentifier

setLanguageId

setMemberId

setName

setParentId

setParentIdentifier

setParentName

setShortDescription

setStoreId

setType