com.plumtree.server
Interface IPTPropertyFilterItem

All Superinterfaces:

IPTUnknown

All Known Subinterfaces:

IPTPropertyFilterClauses, IPTPropertyFilterStatement

public interface IPTPropertyFilterItem
extends IPTUnknown

Filters are used in Plumtree to perform queries- the filter is used to specify which items should be returned in the query. Filters are collections of constraints. Each constraint is an IPTPropertyFilterItem. Some constraints are atomic, in that they specify a match condition (e.g. "Name = 'Fred'"), while others are compound constraints (e.g. "Name = 'Fred' and Department = 'Legal'".) Atomic constraints implement the IPTPropertyFilterStatement interface, while compound constraints implement the IPTPropertyFilterClauses interface. Both of those interfaces are subclasses of this interface- this interface is the base class for all types of filter constraints.

Author:

michaels

See Also:

IPTFilter, IPTPropertyFilterClauses, IPTPropertyFilterStatement

Method Summary

IPTPropertyFilterItem	Clone() Returns a copy of this filter item
void	Export(IPTMigrationElement pMigrationElement, java.lang.String bstrSubElementName) Exports this filter item to a MigrationElement
int	GetType() Returns the type of this filter item, from PT_FILTER_ITEM_TYPES
void	Import(IPTMigrationElement pMigrationElement, java.lang.String bstrSubElementName) Imports this filter item from a MigrationElement

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

GetType

int GetType()

Returns the type of this filter item, from PT_FILTER_ITEM_TYPES

Returns:

filter item type

Clone

IPTPropertyFilterItem Clone()

Returns a copy of this filter item

Returns:

a copy of this filter item

Export

void Export(IPTMigrationElement pMigrationElement,
            java.lang.String bstrSubElementName)

Exports this filter item to a MigrationElement

Parameters:

pMigrationElement - the MigrationElement to which this filter item should be exported

bstrSubElementName - the name of the subelement within the migration element

See Also:

IPTMigrationElement

Import

void Import(IPTMigrationElement pMigrationElement,
            java.lang.String bstrSubElementName)

Imports this filter item from a MigrationElement

Parameters:

pMigrationElement - the MigrationElement from which to import this filter item

bstrSubElementName - the name of the subelement within the migration element

See Also:

IPTMigrationElement