com.netegrity.llsdk6.imsapi.policy.rule
Class MemberRule

java.lang.Object
  com.netegrity.llsdk6.imsapi.policy.rule.MemberRule

All Implemented Interfaces:

TriggerRule, java.lang.Cloneable

public class MemberRule
extends java.lang.Object
implements TriggerRule

Defines a condition that must be satisfied for a user to be assigned to a role.

Since:

Identity Manager 8.1

Constructor Summary

MemberRule(MemberMatchConstraint match, OrgMembershipConstraint org)
Creates a member rule object.

Method Summary

java.lang.Object	clone()
EvaluationType	getEvaluationType() Returns the evaluation type of this rule.
MemberMatchConstraint	getMembermatchConstraint() Retrieves the member match constraint for this rule.
OrgMembershipConstraint	getOrgMembershipConstraint() Retrieves the organization membership constraint for this rule.
java.lang.String	marshall() Creates a serialized String representation of this rule which can be used for transmission/storage of the rule.
java.lang.String	marshall(boolean bCDATA) Creates a serialized String representation of this rule which can be used for transmission/storage of the rule.
void	setMemberMatchConstraint(MemberMatchConstraint cons) Sets a new member match constraint value for this rule, overwriting any previous value.
void	setOrgMembershipConstraint(OrgMembershipConstraint cons) Sets a new organization membership constraint value for this rule, overwriting any previous value.
boolean	wouldMatch(TSContext ctx, ManagedObject obj, java.lang.StringBuffer message) Specifies whether the current form of this managed object matches the rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

MemberRule

public MemberRule(MemberMatchConstraint match,
                  OrgMembershipConstraint org)

Creates a member rule object.

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

getMembermatchConstraint

public MemberMatchConstraint getMembermatchConstraint()

Retrieves the member match constraint for this rule.

Returns:

The member match constraint object.

setMemberMatchConstraint

public void setMemberMatchConstraint(MemberMatchConstraint cons)

Sets a new member match constraint value for this rule, overwriting any previous value.

Parameters:

cons - The new member match constraint value for the rule.

getOrgMembershipConstraint

public OrgMembershipConstraint getOrgMembershipConstraint()

Retrieves the organization membership constraint for this rule.

Returns:

The organization membership constraint object.

setOrgMembershipConstraint

public void setOrgMembershipConstraint(OrgMembershipConstraint cons)

Sets a new organization membership constraint value for this rule, overwriting any previous value.

Parameters:

cons - The new organization membership constraint value for the rule.

marshall

public java.lang.String marshall(boolean bCDATA)

Description copied from interface: TriggerRule

Creates a serialized String representation of this rule which can be used for transmission/storage of the rule.

Specified by:

marshall in interface TriggerRule

Parameters:

bCDATA - If true, the marshalled form will wrap the contents of the rule in a CDATA block.

Returns:

A String representation of this rule.

marshall

public java.lang.String marshall()

Description copied from interface: TriggerRule

Creates a serialized String representation of this rule which can be used for transmission/storage of the rule.

Specified by:

marshall in interface TriggerRule

Returns:

A String representation of this rule.

wouldMatch

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

Description copied from interface: TriggerRule

Specifies whether the current form of this managed object matches the rule.

Specified by:

wouldMatch in interface TriggerRule

Parameters:

ctx - The context in which the rule is evaluated.

obj - The managed object to check.

message - Output parameter for an exception message.

Returns:

true if the managed object matches the rule.

Throws:

SmApiException

getEvaluationType

public EvaluationType getEvaluationType()

Description copied from interface: TriggerRule

Returns the evaluation type of this rule.

The evaluation type is determined by what kinds of constraints make up the rule. The Identity Manager back end uses this information to determine how to evaluate the rule.

Specified by:

getEvaluationType in interface TriggerRule

Returns:

An enumerated value from EvaluationType.