com.plumtree.server
Interface IPTFilter

All Superinterfaces:

IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTFilter
extends IPTObject

Version:

$Revision$

Author:

Stephen Chang The filter object used for searching and or taxonomization exhibits the following relationship to its contained structures: EXAMPLE IPTFilter | +--->Search String (Always present, though may be empty) | +--->Operator (PT_BOOLOPS:and/or) always present | +--->PropertyFilter (clause, statement, or null) | +--->Statement | +--->Operator (PT_BOOLOPS:and/or) | +--->Statement (or nested clause,etc.)

Method Summary

void	ClearPropertyFilter() Purges the contents of the top-level property filter
int	GetFilterType() Reveals the type of filter this object to which this object corresponds.
IPTPropertyFilterItem	GetNewFilterItem(int lType) 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
int	GetOperator() Returns the top level operator as a PT_BOOLOPS for the filter.
IPTPropertyFilterItem	GetPropertyFilter() Returns the top level property filter.
java.lang.String	GetSearchString() Retrieves the string being applied to the basic composite field of indexed content.
int	GetSettings(int Setting) Deprecated.
void	SetOperator(int Value) Sets the top level operator as a PT_BOOLOPS for the filter.
void	SetPropertyFilter(IPTPropertyFilterItem Value) Sets the top level property filter.
void	SetSearchString(java.lang.String Value) Sets the string to be applied to the basic composite field of indexed content.
void	SetSettings(int Value, java.lang.Object pvValue) Sets PT_FILTER_SETTINGS values.

Methods inherited from interface com.plumtree.server.IPTObject

GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified

Methods inherited from interface com.plumtree.server.IPTLocalizable

GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Methods inherited from interface com.plumtree.server.IPTServerContext

GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject

Methods inherited from interface com.plumtree.server.IPTStorable

Store

Method Detail

GetFilterType

int 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.

Returns:

an int as a PT_FILTERTYPES

GetPropertyFilter

IPTPropertyFilterItem 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.

Returns:

a clause or statement object implementing IPTPropertyFilterItem

SetPropertyFilter

void SetPropertyFilter(IPTPropertyFilterItem Value)

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.

Parameters:

filter - a clause or statement object implementing IPTPropertyFilterItem

ClearPropertyFilter

void ClearPropertyFilter()

Purges the contents of the top-level property filter

GetOperator

int 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.

Returns:

a PT_BOOLOPS indicating an AND or OR relationship

SetOperator

void SetOperator(int Value)

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.

Parameters:

Value - an int PT_BOOLOPS indicating an AND or OR relationship

GetSearchString

java.lang.String GetSearchString()

Retrieves the string being applied to the basic composite field of indexed content. (Name, Description, and Full Text)

Returns:

a search String applied to Name, Description, and Full Text

SetSearchString

void SetSearchString(java.lang.String Value)

Sets the string to be applied to the basic composite field of indexed content. (Name, Description, and Full Text)

Parameters:

Value - a search String applied to Name, Description, and Full Text

GetSettings

int GetSettings(int Setting)

Deprecated.

Retrieves PT_FILTER_SETTINGS values. This is not currently exploited and is reserved for future use.

Specified by:

GetSettings in interface IPTServerContext

Parameters:

Setting - - The id of the setting to retrieve. Valid values are from the PT_SERVERCONTEXT_SETTINGS enumeration.

Returns:

an int

SetSettings

void SetSettings(int Value,
                 java.lang.Object pvValue)

Sets PT_FILTER_SETTINGS values. This is not currently exploited and is reserved for future use.

Parameters:

Value - a PT_FILTER_SETTINGS int

pvValue - The object stored for the specified setting

GetNewFilterItem

IPTPropertyFilterItem GetNewFilterItem(int lType)

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

Parameters:

lType - a PT_FILTER_ITEM_TYPES value

Returns:

A property filter object