com.ibm.commerce.tools.campaigns
Class 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
protected  java.lang.String _catalogId
          ID of the catalog the category/catalog entry belongs to.
protected  java.lang.String _catalogIdentifier
          Identifier of the catalog the category/catalog entry belongs to.
protected  java.lang.String _catalogMemberId
          Member ID of the catalog the category/catalog entry belongs to.
protected  java.lang.String _id
          ID of the category/catalog entry.
protected  java.lang.String _identifier
          Identifier of the category/catalog entry.
protected  java.lang.String _memberId
          Member ID of the category/catalog entry.
protected  java.lang.String _name
          Name of the category/catalog entry.
protected  java.lang.String _parentId
          ID of the parent category that this category belongs to.
protected  java.lang.String _parentIdentifier
          Identifier of the parent category that this category belongs to.
protected  java.lang.String _parentName
          Name of the parent category that this category belongs to.
protected  java.lang.String _shortDescription
          Short description of the category/catalog entry.
protected  java.lang.String _type
          Type of the category/catalog entry.
protected  CommandContext commandContext
          Current command context that is used to retrieve the runtime attribute like the store ID and the member ID.
static java.lang.String COPYRIGHT
          IBM copyright notice field.
protected  java.lang.String languageId
          Languague ID that is currently being used.
protected  java.lang.String storeId
          ID of the store that is currently logged on to.
 
Constructor Summary
CatalogSearchDataBean()
          Constructor for CatalogSearchDataBean.
 
Method Summary
 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.
  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 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 languague 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( 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 languague 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

_catalogId

protected java.lang.String _catalogId
ID of the catalog the category/catalog entry belongs to.

_catalogIdentifier

protected java.lang.String _catalogIdentifier
Identifier of the catalog the category/catalog entry belongs to.

_catalogMemberId

protected java.lang.String _catalogMemberId
Member ID of the catalog the category/catalog entry belongs to.

_id

protected java.lang.String _id
ID of the category/catalog entry.

_identifier

protected java.lang.String _identifier
Identifier of the category/catalog entry.

_memberId

protected java.lang.String _memberId
Member ID of the category/catalog entry.

_name

protected java.lang.String _name
Name of the category/catalog entry.

_shortDescription

protected java.lang.String _shortDescription
Short description of the category/catalog entry.

_type

protected java.lang.String _type
Type of the category/catalog entry.

_parentId

protected java.lang.String _parentId
ID of the parent category that this category belongs to.

_parentIdentifier

protected java.lang.String _parentIdentifier
Identifier of the parent category that this category belongs to.

_parentName

protected java.lang.String _parentName
Name of the parent category that this category belongs to.

storeId

protected java.lang.String storeId
ID of the store that is currently logged on to.

languageId

protected java.lang.String languageId
Languague ID that is currently being used.

commandContext

protected CommandContext commandContext
Current command context that is used to retrieve the runtime attribute like the store ID and the member ID.
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 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

getShortDescription

public java.lang.String getShortDescription()
Gets the short description of the category/catalog entry.
Returns:
short description 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 languague 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

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(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

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

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 languague 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

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