com.plumtree.portaluiinfrastructure.filter
Interface IFilterIteratorRO

All Superinterfaces:
IModelRO, IMVCObject
All Known Implementing Classes:
FilterIterator

public interface IFilterIteratorRO
extends IModelRO

Author:
CraigS, based on MikeS code

Method Summary
 boolean AddSetProperty(QueryCondition qc)
           
 int GetCurrentClauseDepth()
          Gets the depth of the current clause.
 boolean GetCurrentClauseOperator()
          Gets the operator (AND or OR) that joins the current clause together.
 boolean GetNextClausePosition()
           
 boolean GetNextStatementAndSetQC(QueryCondition qc)
           
 int GetNumItemsInFirstClause()
          Convenience method to return the number of items in the first clause; basically an easy way to see if this filter contains anything of interest
 IASQueryResult GetPropertiesVisibleToCurrentUser()
          Queries the database for the set of properties this user can see (on the first call), returns a cached value on subsequent calls.
 java.lang.String GetTextSearchString()
          Gets the filter's top-level search string.
 boolean GetTopLevelAllMustPass()
           
 QueryCondition MakeQueryCondition()
          Make a brand-new QueryCondition.
 void SetIteratorToStart()
          Resets this iterator to the beginning.
 
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject
GetName
 

Method Detail

MakeQueryCondition

QueryCondition MakeQueryCondition()
Make a brand-new QueryCondition.


GetCurrentClauseDepth

int GetCurrentClauseDepth()
Gets the depth of the current clause.

Returns:
the depth of the current clause.

GetCurrentClauseOperator

boolean GetCurrentClauseOperator()
Gets the operator (AND or OR) that joins the current clause together.

Returns:
the operator

GetTextSearchString

java.lang.String GetTextSearchString()
Gets the filter's top-level search string.

Returns:
the search string

GetNextClausePosition

boolean GetNextClausePosition()
Returns:

GetNextStatementAndSetQC

boolean GetNextStatementAndSetQC(QueryCondition qc)
Parameters:
qc -
Returns:

AddSetProperty

boolean AddSetProperty(QueryCondition qc)
Parameters:
qc -
Returns:

GetNumItemsInFirstClause

int GetNumItemsInFirstClause()
Convenience method to return the number of items in the first clause; basically an easy way to see if this filter contains anything of interest


GetPropertiesVisibleToCurrentUser

IASQueryResult GetPropertiesVisibleToCurrentUser()
Queries the database for the set of properties this user can see (on the first call), returns a cached value on subsequent calls.


GetTopLevelAllMustPass

boolean GetTopLevelAllMustPass()
Returns:

SetIteratorToStart

void SetIteratorToStart()
Resets this iterator to the beginning.




Copyright © 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.