public class CategoryFilter extends java.lang.Object implements Filter
<Filter impl="com.ibm.commerce.marketing.promotion.condition.CategoryFilter"> <IncludeCategory> <CategoryKey> <DN>Root Organization</DN> <Name>Pants</Name> </CategoryKey> </IncludeCategory> <ExcludeCategory> <CategoryKey> <DN>Root Organization</DN> <Name>Sweaters</Name> </CategoryKey> </ExcludeCategory> </Filter>
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
IBM copyright notice field.
|
Constructor and Description |
---|
CategoryFilter()
Constructor for CategoryFilter.
|
Modifier and Type | Method and Description |
---|---|
void | addToExclusionList(CategoryKey key)
This method adds the CategoryKey to the exclusion category list.
|
void | addToExclusionList(java.lang.String aDN, java.lang.String name)
This method adds the CategoryKey identified by it's DN and Identifier to the Exclusion CategoryList.
|
void | addToInclusionList(CategoryKey key)
This method adds the CategoryKey to the inclusion category list.
|
void | addToInclusionList(java.lang.String aDN, java.lang.String name)
This method adds the CategoryKey identified by it's DN and Identifier, to the inclusion category list.
|
boolean | belongsToExclusionList(CategoryKey key)
This method checks if CategoryKey belongs to the exclusion category list.
|
boolean | belongsToExclusionList(java.lang.String aDN, java.lang.String name)
This method checks if CategoryKey identified by it's DN and identifier belongs to the exclusion category list.
|
boolean | belongsToInclusionList(CategoryKey key)
This method checks if CategoryKey belongs to the inclusion category list.
|
boolean | belongsToInclusionList(java.lang.String aDN, java.lang.String name)
This method checks if CategoryKey identified by it's DN and identifier belongs to the inclusion category list.
|
LineItemSet | filter(LineItemSet input, PromotionContext context)
This method performs the business logic to filter the input LineItemSet and return a subset of the original LineItemSet.
|
void | fromXML(org.w3c.dom.Node anXMLNode)
Transforms the XML node into its corresponding real Object.
|
CategoryKey[] | getExclusionList()
This method gets the list of CategoryKey in the exclusion category list.
|
CategoryKey[] | getInclusionList()
This method gets the list of CategoryKey in the inclusion category list.
|
void | removeFromExclusionList(CategoryKey key)
This method removes the CategoryKey from the exclusion category list.
|
void | removeFromExclusionList(java.lang.String aDN, java.lang.String name)
This method removes the CategoryKey identified by it's DN and identifier from the exclusion category list.
|
void | removeFromInclusionList(CategoryKey key)
This method removes the CategoryKey from the inclusion category list.
|
void | removeFromInclusionList(java.lang.String aDN, java.lang.String name)
This method removes the CategoryKey identified by it's DN and identifier from the inclusion category list.
|
java.lang.String | toXML()
Converts the object into its corresponding XML format representation.
|
public static final java.lang.String COPYRIGHT
public CategoryKey[] getInclusionList()
public CategoryKey[] getExclusionList()
public void addToInclusionList(java.lang.String aDN, java.lang.String name)
public void addToInclusionList(CategoryKey key)
public void addToExclusionList(java.lang.String aDN, java.lang.String name)
public void addToExclusionList(CategoryKey key)
public void removeFromExclusionList(java.lang.String aDN, java.lang.String name)
public void removeFromExclusionList(CategoryKey key)
public void removeFromInclusionList(java.lang.String aDN, java.lang.String name)
public void removeFromInclusionList(CategoryKey key)
public boolean belongsToInclusionList(java.lang.String aDN, java.lang.String name)
public boolean belongsToInclusionList(CategoryKey key)
public boolean belongsToExclusionList(java.lang.String aDN, java.lang.String name)
public boolean belongsToExclusionList(CategoryKey key)
public LineItemSet filter(LineItemSet input, PromotionContext context)
public java.lang.String toXML() throws XMLizationException
public void fromXML(org.w3c.dom.Node anXMLNode) throws DeXMLizationException