Aqualogic Interaction API  
 

IPTFilter Members

IPTFilter overview

Public Instance Methods

ClearPropertyFilter Purges the contents of the top-level property filter
GetFilterType Reveals the type of filter this object to which this object corresponds. The types defined as PT_FILTERTYPES determine whether the filter can be used for search or classification.
GetNewFilterItem Returns a newly created property filter item Object as an IPTPropertyFilterItem which may then be cast to either an IPTPropertyFilterStatement or IPTPropertyFilterClauses depending on whether the request parameter specified the value as PT_FILTER_ITEM_TYPES.PT_FILTER_ITEM_STATEMENT or PT_FILTER_ITEM_TYPES.PT_FILTER_ITEM_CLAUSES
GetOperator Returns the top level operator as a PT_BOOLOPS for the filter. This operator expresses the conditional relationship between the filter's basic composite field condition (SearchString) and its property filter (if any). A filter's basic composite field condition is a top level single instance search against a combination of the name, description, and full text of indexed items. This operator does not have any significance for items contained in any clause assigned to the propery filter component of this filter.
GetPropertyFilter Returns the top level property filter. Currently, this object may be either a clause or a statement. A clause is simply a container item which in turn contains some number of additional clauses or statements. The clause object is accessed through the IPTPropertyFilterClauses interface and the statement object is accessed through the IPTPropertyFilterStatement interface, both of which extend the IPTPropertyFilterItem interface from which a GetType method is provided for convenience.
GetSearchString Retrieves the string being applied to the basic composite field of indexed content. (Name, Description, and Full Text)
GetSettings Retrieves PT_FILTER_SETTINGS values. This is not currently exploited and is reserved for future use.
SetOperator Sets the top level operator as a PT_BOOLOPS for the filter. This operator expresses the conditional relationship between the filter's basic composite field condition (SearchString) and its property filter (if any). A filter's basic composite field condition is a top level single instance search against a combination of the name, description, and full text of indexed items. This operator does not have any significance for items contained in any clause assigned to the propery filter component of this filter.
SetPropertyFilter Sets the top level property filter. Currently, this object may be either a clause or a statement. A clause is simply a container item which in turn contains some number of additional clauses or statements. The clause object is accessed through the IPTPropertyFilterClauses interface and the statement object is accessed through the IPTPropertyFilterStatement interface, both of which extend the IPTPropertyFilterItem interface from which a GetType method is provided for convenience.
SetSearchString Sets the string to be applied to the basic composite field of indexed content. (Name, Description, and Full Text)
SetSettings Sets PT_FILTER_SETTINGS values. This is not currently exploited and is reserved for future use.

See Also

IPTFilter Interface | com.plumtree.server Namespace