com.netegrity.llsdk6.imsapi.search
Class SearchExpression

java.lang.Object
  com.netegrity.llsdk6.imsapi.search.SearchExpression

public class SearchExpression
extends java.lang.Object

Defines a search expression. Each expression is made up of an attribute name, an operator, and a filter. For example, a search expression might be:

      title EQUALS manager 

This search expression matches objects whose title attribute is an exact match of the string manager.

Possible search expression operators are defined by OperatorType, and possible search expression conjunctions are defined by ConjunctionType,

Since:

IdentityMinder 5.6 SP 2

Constructor Summary

SearchExpression(java.lang.String attribute, OperatorType operator, java.lang.String filter)
Creates a search expression.

Method Summary

java.lang.String	encode() Generates a machine-friendly, encoded String representation of this object.
java.lang.String	getAttribute() Retrieves the name of the attribute for this SearchExpression.
OperatorType	getOperator() Retrieves the operator for this SearchExpression.
java.lang.String	getSearchFilter() Retrieves the filter string for this SearchExpression.
void	setAttribute(java.lang.String newAttribute) Changes the attribute name for this SearchExpression.
void	setOperator(OperatorType newOperator) Changes the operator for this SearchExpression.
void	setSearchFilter(java.lang.String newFilter) Changes the filter string for this SearchExpression.
java.lang.String	toString() Generates a human-readable String representation of this object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchExpression

public SearchExpression(java.lang.String attribute,
                        OperatorType operator,
                        java.lang.String filter)

Creates a search expression.

The following example creates a search expression that searches the AccountName attribute for any account names that begin with the string jen:

      SearchExpression exp = new SearchExpression("AcountName",
                                                  OperatorType.EQUALS,
                                                  "jen*" ); 

Parameters:

attribute - The name of the attribute involved in the search.

operator - The operator to use for the search.

filter - The string to search for in the attribute.

Method Detail

getAttribute

public java.lang.String getAttribute()

Retrieves the name of the attribute for this SearchExpression.

Returns:

The attribute name.

setAttribute

public void setAttribute(java.lang.String newAttribute)

Changes the attribute name for this SearchExpression.

Parameters:

newAttribute - The new attribute name to use in the search.

getOperator

public OperatorType getOperator()

Retrieves the operator for this SearchExpression.

Returns:

The search expression operator.

setOperator

public void setOperator(OperatorType newOperator)

Changes the operator for this SearchExpression.

Parameters:

newOperator - The new operator to use in the search.

getSearchFilter

public java.lang.String getSearchFilter()

Retrieves the filter string for this SearchExpression.

Returns:

The search filter.

setSearchFilter

public void setSearchFilter(java.lang.String newFilter)

Changes the filter string for this SearchExpression.

Parameters:

newFilter - The new filter string to use in the search.

toString

public java.lang.String toString()

Generates a human-readable String representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

A String version of the search expression.

encode

public java.lang.String encode()

Generates a machine-friendly, encoded String representation of this object.

Returns:

A String version of the search expression.