com.filenet.wcm.toolkit.server.util.xml
Class SearchExecuteData.ObjectTypeData

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.xml.SearchExecuteData.ObjectTypeData
Direct Known Subclasses:
SearchExecuteData.CommonObjectTypeData
Enclosing class:
SearchExecuteData

public class SearchExecuteData.ObjectTypeData
extends java.lang.Object

This class represents search criteria for each individual object type.


Field Summary
protected  java.util.Set excludedClasses
           
protected  java.util.Map includeSubclassesMap
           
protected  java.util.Map propertyItems
           
protected  java.util.Set selectProperties
           
protected  java.util.Map verityItems
           
 
Constructor Summary
SearchExecuteData.ObjectTypeData()
           
 
Method Summary
 void addExcludedClass(java.lang.String classSymbolicName)
          Adds an excluded class
 void addExcludedClasses(java.util.Collection classSymbolicNames)
          Adds a collection of excluded classes
 void addIncludeSubclassesClass(java.util.Map includeSubclasses)
          Gets a collection of include subclass classes
 void addProperty(java.lang.String id, java.lang.String value)
          Adds new property that is used in a search template
 void addProperty(java.lang.String id, java.lang.String value, java.lang.String userTextAttribute)
          Adds a new property with userTextAttribute
 void addSelectProperties(java.util.Collection symbolicNames)
          Adds a collection of select property symbolic names.
 void addSelectProperties(java.lang.String[] symbolicNames)
          Adds a String Array of select property symbolic names.
 void addSelectProperty(java.lang.String symbolicName)
          Adds select property.
 void addVerityCriteria(java.lang.String id, java.lang.String text, java.lang.String operator, java.lang.String zone)
          Adds new verity criteria that is used in a search teplate
 boolean isEmpty()
          Returns true if this ObjectTypesData object is empty
 boolean isTemplateDataEmpty()
          Returns true if this ObjectTypesData object has empty criteria
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

selectProperties

protected java.util.Set selectProperties

propertyItems

protected java.util.Map propertyItems

verityItems

protected java.util.Map verityItems

excludedClasses

protected java.util.Set excludedClasses

includeSubclassesMap

protected java.util.Map includeSubclassesMap
Constructor Detail

SearchExecuteData.ObjectTypeData

public SearchExecuteData.ObjectTypeData()
Method Detail

addExcludedClass

public void addExcludedClass(java.lang.String classSymbolicName)
Adds an excluded class

Parameters:
classSymbolicName -

addExcludedClasses

public void addExcludedClasses(java.util.Collection classSymbolicNames)
Adds a collection of excluded classes

Parameters:
classSymbolicNames -

addIncludeSubclassesClass

public void addIncludeSubclassesClass(java.util.Map includeSubclasses)
Gets a collection of include subclass classes

Parameters:
includeSubclasses -

addSelectProperty

public void addSelectProperty(java.lang.String symbolicName)
Adds select property. This property will be included in the search results

Parameters:
symbolicName -

addSelectProperties

public void addSelectProperties(java.util.Collection symbolicNames)
Adds a collection of select property symbolic names.

Parameters:
symbolicNames -

addSelectProperties

public void addSelectProperties(java.lang.String[] symbolicNames)
Adds a String Array of select property symbolic names.

Parameters:
symbolicNames -

addProperty

public void addProperty(java.lang.String id,
                        java.lang.String value)
Adds new property that is used in a search template

Parameters:
id - item id in the search definition
value -

addProperty

public void addProperty(java.lang.String id,
                        java.lang.String value,
                        java.lang.String userTextAttribute)
Adds a new property with userTextAttribute

Parameters:
id -
value -
userTextAttribute -

addVerityCriteria

public void addVerityCriteria(java.lang.String id,
                              java.lang.String text,
                              java.lang.String operator,
                              java.lang.String zone)
Adds new verity criteria that is used in a search teplate

Parameters:
id - item id in the search definition
text -
operator -
zone -

isEmpty

public boolean isEmpty()
Returns true if this ObjectTypesData object is empty

Returns:

isTemplateDataEmpty

public boolean isTemplateDataEmpty()
Returns true if this ObjectTypesData object has empty criteria

Returns:


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.