com.plumtree.server
Interface IPTPropertyFilterClauses

All Superinterfaces:

IPTPropertyFilterItem, IPTUnknown

public interface IPTPropertyFilterClauses
extends IPTPropertyFilterItem

A PropertyFilterClauses element is an element within a filter that contains PropertyFilterStatements and other PropertyFilterClauses. Through the use of PropertyFilterClauses, a filter can contain a "tree" of conditions, and can be arbitrarily complex. See the documentation on IPTPropertyFilterItem for information on the relation between clauses, items, and statements.

Author:

michaels

See Also:

IPTFilter, IPTPropertyFilterItem, IPTPropertyFilterStatement

Method Summary

void	AddItem(IPTPropertyFilterItem pItem, int nIndex) A PropertyFilterClauses object is essentially a list of PropertyFilterItems.
void	Clear() Removes all PropertyFilterItems
int	GetCount() A PropertyFilterClauses object is essentially a list of PropertyFilterItems.
IPTPropertyFilterItem	GetItem(int nIndex) A PropertyFilterClauses object is essentially a list of PropertyFilterItems.
int	GetOperator() Returns the operator- the way that the clauses will be logically joined together
void	RemoveItem(int nIndex) A PropertyFilterClauses object is essentially a list of PropertyFilterItems.
void	SetOperator(int Value) Sets the operator- the way that the clauses will be logically joined together

Methods inherited from interface com.plumtree.server.IPTPropertyFilterItem

Clone, Export, GetType, Import

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

SetOperator

void SetOperator(int Value)

Sets the operator- the way that the clauses will be logically joined together

Parameters:

Value - a value from PT_BOOLOPS

See Also:

PT_BOOLOPS

GetOperator

int GetOperator()

Returns the operator- the way that the clauses will be logically joined together

Returns:

a value from PT_BOOLOPS

See Also:

PT_BOOLOPS

GetItem

IPTPropertyFilterItem GetItem(int nIndex)

A PropertyFilterClauses object is essentially a list of PropertyFilterItems. This method returns the PropertyFilterItem at the specified index.

Parameters:

nIndex - the index of the item to be retrieved

Returns:

the PropertyFilterItem at the index

See Also:

IPTPropertyFilterItem

AddItem

void AddItem(IPTPropertyFilterItem pItem,
             int nIndex)

A PropertyFilterClauses object is essentially a list of PropertyFilterItems. This method adds a new PropertyFilterItem at the specified index.

Parameters:

pItem - the item to be added

nIndex - the index at which to add it

See Also:

IPTPropertyFilterItem

RemoveItem

void RemoveItem(int nIndex)

A PropertyFilterClauses object is essentially a list of PropertyFilterItems. This method removes the PropertyFilterItem at the specified index.

Parameters:

nIndex - the index of the item to remove

GetCount

int GetCount()

A PropertyFilterClauses object is essentially a list of PropertyFilterItems. This method returns the number of items

Returns:

the number of PropertyFilterItems

Clear

void Clear()

Removes all PropertyFilterItems