com.ibm.commerce.tools.contract.beans
Class CatalogFilterDataBean

java.lang.Object
  |
  +--com.ibm.commerce.beans.InputDataBeanImpl
        |
        +--com.ibm.commerce.beans.SmartDataBeanImpl
              |
              +--com.ibm.commerce.tools.contract.beans.CatalogFilterDataBean
All Implemented Interfaces:
DataBean, InputDataBean, java.io.Serializable, SmartDataBean

public class CatalogFilterDataBean
extends SmartDataBeanImpl

Holds all the information pertinent to a single node within the Catalog Filter.

See Also:
Serialized Form

Field Summary
static int ACTION_TYPE_DELETE
          Catalog Filter Databean Term and Condition action type "delete"
static int ACTION_TYPE_NEW
          Catalog Filter Databean Term and Condition action type "new"
static int ACTION_TYPE_NOACTION
          Catalog Filter Databean Term and Condition action type "noaction"
static int ACTION_TYPE_UPDATE
          Catalog Filter Databean Term and Condition action type "update"
static int ENTITLEMENT_TYPE_EXCLUDE
          Catalog Filter Databean entitlement type Include.
static int ENTITLEMENT_TYPE_INCLUDE
          Catalog Filter Databean entitlement type Exclude.
static int FILTER_TYPE_CATALOG
          Catalog Filter Databean represents a Catalog node (the master catalog)
static int FILTER_TYPE_CATEGORY
          Catalog Filter Databean represents a Category node
static int FILTER_TYPE_CATENTRY
          Catalog Filter Databean represents a Catentry node
 
Fields inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
commandContext, COPYRIGHT
 
Fields inherited from class com.ibm.commerce.beans. InputDataBeanImpl
requestProperties
 
Fields inherited from interface com.ibm.commerce.beans. DataBean
emptyString
 
Constructor Summary
CatalogFilterDataBean()
           
 
Method Summary
 java.lang.String getActionType()
          Get the action type for this filter
static java.lang.String getActionType(int actionType)
          Get the action type for this filter
 java.lang.String getAdjustment()
          Get the percentage adjustment for this filter
 java.lang.String getEntitlementType()
          Get the entitlement type for this filter
static java.lang.String getEntitlementType(int entitlementType)
          Get the entitlement type for this filter
 java.lang.String getFilterType()
          Get the filter type for this filter
static java.lang.String getFilterType(int filterType)
          Get the filter type for a specified filter
 java.lang.String getIdentifier()
          Get the identifier for this filter
 java.lang.String getNodeReferenceNumber()
          Get the node reference number for this filter
 java.lang.String getOwner()
          Get the owner for this filter
 java.lang.String getPrecedence()
          Get the precedence for this filter
 java.lang.String getReferenceNumber()
          Get the reference number for this filter
 java.lang.Long getReferenceNumberL()
          Get the long represenation of the reference number for this filter
 java.lang.Boolean getSynched()
          Get the synchronization flag for this filter
 boolean isActionType(int actionTypeArg)
          Test to determine whether the action type of this filter is of the specified type
 boolean isEntitlementType(int entitlementTypeArg)
          Test to determine whether the entitlement type of this filter is of the specified type
 boolean isFilterType(int filterTypeArg)
          Test to determine whether the filter type of this filter is of the specified type
 void populate()
          This method is the main body of this databean and is executed when the bean is activated.
 void setActionType(java.lang.String newActionType)
          Set the action type for this filter
 void setAdjustment(java.lang.String newAdjustment)
          Set the percentage adjustment for this filter
 void setEntitlementType(java.lang.String newEntitlementType)
          Set the entitlement type for this filter
 void setFilterType(java.lang.String newFilterType)
          Set the filter type for this filter
 void setOwner(java.lang.String newOwner)
          Set the owner for this filter
 void setPrecedence(java.lang.String newPrecedence)
          Set the precedence for this filter
 void setReferenceNumber(java.lang.String newReferenceNumber)
          Set the reference number for this filter
 void setSynched(java.lang.Boolean newSynched)
          Set the synchronization flag for this filter
 java.lang.String toString()
          Converts this data bean to a readable string representation for debugging purposes.
 
Methods inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
fulfills, getCommandContext, getResources, setCommandContext
 
Methods inherited from class com.ibm.commerce.beans. InputDataBeanImpl
getRequestProperties, setRequestProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.beans. InputDataBean
getRequestProperties, setRequestProperties
 

Field Detail

FILTER_TYPE_CATALOG

public static final int FILTER_TYPE_CATALOG
Catalog Filter Databean represents a Catalog node (the master catalog)
See Also:
Constant Field Values

FILTER_TYPE_CATEGORY

public static final int FILTER_TYPE_CATEGORY
Catalog Filter Databean represents a Category node
See Also:
Constant Field Values

FILTER_TYPE_CATENTRY

public static final int FILTER_TYPE_CATENTRY
Catalog Filter Databean represents a Catentry node
See Also:
Constant Field Values

ENTITLEMENT_TYPE_EXCLUDE

public static final int ENTITLEMENT_TYPE_EXCLUDE
Catalog Filter Databean entitlement type Include. A node can be included or excluded
See Also:
Constant Field Values

ENTITLEMENT_TYPE_INCLUDE

public static final int ENTITLEMENT_TYPE_INCLUDE
Catalog Filter Databean entitlement type Exclude. A node can be included or excluded
See Also:
Constant Field Values

ACTION_TYPE_NOACTION

public static final int ACTION_TYPE_NOACTION
Catalog Filter Databean Term and Condition action type "noaction"
See Also:
Constant Field Values

ACTION_TYPE_NEW

public static final int ACTION_TYPE_NEW
Catalog Filter Databean Term and Condition action type "new"
See Also:
Constant Field Values

ACTION_TYPE_UPDATE

public static final int ACTION_TYPE_UPDATE
Catalog Filter Databean Term and Condition action type "update"
See Also:
Constant Field Values

ACTION_TYPE_DELETE

public static final int ACTION_TYPE_DELETE
Catalog Filter Databean Term and Condition action type "delete"
See Also:
Constant Field Values
Constructor Detail

CatalogFilterDataBean

public CatalogFilterDataBean()
Method Detail

populate

public void populate()
              throws java.lang.Exception
This method is the main body of this databean and is executed when the bean is activated. This bean does not require any special populate processing and so does nothing...
Specified by:
populate in interface SmartDataBean
Overrides:
populate in class SmartDataBeanImpl
Throws:
java.lang.Exception

getActionType

public java.lang.String getActionType()
Get the action type for this filter
Returns:
String

getActionType

public static java.lang.String getActionType(int actionType)
Get the action type for this filter
Parameters:
actionType - int
Returns:
String

getAdjustment

public java.lang.String getAdjustment()
Get the percentage adjustment for this filter
Returns:
String

getEntitlementType

public java.lang.String getEntitlementType()
Get the entitlement type for this filter
Returns:
String

getEntitlementType

public static java.lang.String getEntitlementType(int entitlementType)
Get the entitlement type for this filter
Parameters:
entitlementType - int
Returns:
String

getFilterType

public java.lang.String getFilterType()
Get the filter type for this filter
Returns:
String

getFilterType

public static java.lang.String getFilterType(int filterType)
Get the filter type for a specified filter
Parameters:
filterType - int
Returns:
String

getIdentifier

public java.lang.String getIdentifier()
Get the identifier for this filter
Returns:
String

getNodeReferenceNumber

public java.lang.String getNodeReferenceNumber()
Get the node reference number for this filter
Returns:
String

getOwner

public java.lang.String getOwner()
Get the owner for this filter
Returns:
String

getPrecedence

public java.lang.String getPrecedence()
Get the precedence for this filter
Returns:
String

getReferenceNumber

public java.lang.String getReferenceNumber()
Get the reference number for this filter
Returns:
String

getReferenceNumberL

public java.lang.Long getReferenceNumberL()
Get the long represenation of the reference number for this filter
Returns:
Long

getSynched

public java.lang.Boolean getSynched()
Get the synchronization flag for this filter
Returns:
Boolean

isActionType

public boolean isActionType(int actionTypeArg)
Test to determine whether the action type of this filter is of the specified type
Parameters:
actionTypeArg - int
Returns:
boolean

isEntitlementType

public boolean isEntitlementType(int entitlementTypeArg)
Test to determine whether the entitlement type of this filter is of the specified type
Parameters:
entitlementTypeArg - int
Returns:
boolean

isFilterType

public boolean isFilterType(int filterTypeArg)
Test to determine whether the filter type of this filter is of the specified type
Parameters:
filterTypeArg - int
Returns:
boolean

setActionType

public void setActionType(java.lang.String newActionType)
Set the action type for this filter
Parameters:
newActionType - String

setAdjustment

public void setAdjustment(java.lang.String newAdjustment)
Set the percentage adjustment for this filter
Parameters:
newAdjustment - Long

setEntitlementType

public void setEntitlementType(java.lang.String newEntitlementType)
Set the entitlement type for this filter
Parameters:
newEntitlementType - String

setFilterType

public void setFilterType(java.lang.String newFilterType)
Set the filter type for this filter
Parameters:
newFilterType - String

setOwner

public void setOwner(java.lang.String newOwner)
Set the owner for this filter
Parameters:
newOwner - String

setPrecedence

public void setPrecedence(java.lang.String newPrecedence)
Set the precedence for this filter
Parameters:
newPrecedence - String

setReferenceNumber

public void setReferenceNumber(java.lang.String newReferenceNumber)
Set the reference number for this filter
Parameters:
newReferenceNumber - String

setSynched

public void setSynched(java.lang.Boolean newSynched)
Set the synchronization flag for this filter
Parameters:
newSynched - Boolean

toString

public java.lang.String toString()
Converts this data bean to a readable string representation for debugging purposes.
Overrides:
toString in class java.lang.Object
Returns:
String