com.centrasite.resourceaccess.utilities.search
Interface SearchFilter


public interface SearchFilter

To be used for querying external repositories e.g. UserManager.getUnregisteredUsers(String), GroupManager.getUnregisteredGroups(String). Default behavior is having ALL custom predicate i.e. wildcard "*".


Nested Class Summary
static class SearchFilter.LogicalOperation
          Supported logical operations between predicates.
 
Method Summary
 void addPredicate(AbstractPredicate predicate)
          Used to define searches over supported external repository properties.
 SearchFilter.LogicalOperation getLogicalOperation()
          Get the currently effective logical operation to be used between the defined complex predicates.
 void setCustomPredicate(java.lang.String customPredicate)
          Used to define custom unstructured searches e.g.
 void setLogicalOperation(SearchFilter.LogicalOperation logicalOperation)
          Set the logical operation to be used between the defined complex predicates.
 java.lang.String toStringFilter()
          Perform the actual parsing of this SearchFilter.
 

Method Detail

toStringFilter

java.lang.String toStringFilter()
                                throws java.text.ParseException
Perform the actual parsing of this SearchFilter.

Returns:
String representation of this SearchFilter. To be used as input to UserManager.getUnregisteredUsers(String), GroupManager.getUnregisteredGroups(String)
Throws:
java.text.ParseException - If this SearchFilter encounters problems during parsing of its predicates.

setCustomPredicate

void setCustomPredicate(java.lang.String customPredicate)
Used to define custom unstructured searches e.g. Fully Qualified Name in the form "DOMAIN\\name".

Parameters:
customPredicate -
Throws:
java.lang.UnsupportedOperationException - If the currently effective external repository does not support custom predicate.

addPredicate

void addPredicate(AbstractPredicate predicate)
Used to define searches over supported external repository properties.

Parameters:
predicate -
Throws:
java.lang.UnsupportedOperationException - If the currently effective external repository does not support predicates.

getLogicalOperation

SearchFilter.LogicalOperation getLogicalOperation()
Get the currently effective logical operation to be used between the defined complex predicates.


setLogicalOperation

void setLogicalOperation(SearchFilter.LogicalOperation logicalOperation)
Set the logical operation to be used between the defined complex predicates.

Parameters:
logicalOperation - SearchFilter.LogicalOperation