com.netegrity.llsdk6.imsapi.policy.rule.constraints
Class AttributeExpression

java.lang.Object
  com.netegrity.llsdk6.imsapi.policy.rule.constraints.AttributeExpression

All Implemented Interfaces:

java.lang.Cloneable

public class AttributeExpression
extends java.lang.Object
implements java.lang.Cloneable

Indicates one or more managed object attributes to use as search criteria.

This object is used in filters such as UserFilter and constraints such as OrgMembershipConstraint.

Since:

Identity Manager 8.1

Constructor Summary

AttributeExpression(java.lang.String attribute, OperatorType operator, java.lang.String filter)
Creates a new attribute expression.

Method Summary

java.lang.Object	clone()
java.lang.String	getAttribute() Retrieves the name of this attribute expression.
OperatorType	getOperator() Retrieves the operator used in the attribute expression, such as equal to or greater than the filter to search for.
java.lang.String	getSearchFilter() Retrieves the string value to search for.
AttributeExpressionType	getType() Retrieves the type of this attribute expression.
java.lang.String	marshall() Generates a machine-friendly encoded string representation of this object.
void	setAttribute(java.lang.String newAttribute) Renames the attribute expression.
void	setOperator(OperatorType newOperator) Assigns a different operator to the attribute expression.
void	setSearchFilter(java.lang.String newFilter) Changes the search filter used in the attribute expression.
java.lang.String	toString() Generates a human-friendly string representation of this object.
boolean	wouldMatch(TSContext ctx, ManagedObject obj, java.lang.StringBuffer message) Specifies whether the current form of this managed object matches the attribute expression.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeExpression

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

Creates a new attribute expression.

Parameters:

attribute - The name of this attribute expression.

operator - The search operator, such as equal to or greater than the filter value.

filter - The string value to search for.

Method Detail

getAttribute

public java.lang.String getAttribute()

Retrieves the name of this attribute expression.

Returns:

The attribute name.

setAttribute

public void setAttribute(java.lang.String newAttribute)

Renames the attribute expression.

Parameters:

newAttribute - The new name for the attribute expression.

getOperator

public OperatorType getOperator()

Retrieves the operator used in the attribute expression, such as equal to or greater than the filter to search for.

Returns:

The type of operator used in the expression.

setOperator

public void setOperator(OperatorType newOperator)

Assigns a different operator to the attribute expression.

Parameters:

newOperator - The new operator to use in the expression.

getSearchFilter

public java.lang.String getSearchFilter()

Retrieves the string value to search for.

Returns:

The search filter.

setSearchFilter

public void setSearchFilter(java.lang.String newFilter)

Changes the search filter used in the attribute expression.

Parameters:

newFilter - The new search filter.

toString

public java.lang.String toString()

Generates a human-friendly string representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

The string that represents the attribute expression.

marshall

public java.lang.String marshall()

Generates a machine-friendly encoded string representation of this object.

Returns:

An encoded string representation of the attribute expression

getType

public AttributeExpressionType getType()

Retrieves the type of this attribute expression. AttributeExpression objects are of type BASIC.

wouldMatch

public boolean wouldMatch(TSContext ctx,
                          ManagedObject obj,
                          java.lang.StringBuffer message)
                   throws SmApiException

Specifies whether the current form of this managed object matches the attribute expression.

Parameters:

ctx - The context in which the attribute expression is evaluated.

obj - The managed object to check.

message - Output parameter for an exception message.

Returns:

true if the managed object matches the search expression.

Throws:

SmApiException

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object