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

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

All Implemented Interfaces:

TriggerRule, java.lang.Cloneable

public class ScopeRule
extends java.lang.Object
implements TriggerRule

Defines a condition used to determine the set of objects that can be managed by a member or administrator of a role.

Scope rules are used in member policies and admin policies as follows:

• In member policies, scope rules determine the set of users, groups, organizations, and access tasks that can be managed with the role.
• In admin policies, scope rules determine the set of role members and role administrators that the administrator can manage.

Since:

Identity Manager 8.1

Constructor Summary

ScopeRule(ScopeMatchConstraint match, ObjectType ot)
Creates a scope rule object.

ScopeRule(ScopeMatchConstraint match, ObjectType ot, ScopePurpose sp)
Creates a scope rule object.

ScopeRule(ScopeMatchConstraint match, OrgScopeConstraint org, ObjectType ot)
Creates a scope rule object.

Method Summary

java.lang.Object	clone()
EvaluationType	getEvaluationType() Returns the evaluation type of this rule.
ObjectType	getObjectType() Retrieves the type of object associated with this scope rule.
OrgScopeConstraint	getOrgScopeConstraint() Retrieves the organization scope constraint for this rule.
ScopeMatchConstraint	getScopeMatchConstraint() Retrieves the scope match constraint for this rule.
ScopePurpose	getScopePurpose()
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	setOrgScopeConstraint(OrgScopeConstraint cons) Sets a new organization scope constraint value for this rule, overwriting any previous value.
void	setScopeMatchConstraint(ScopeMatchConstraint cons) Sets a new scope match constraint value for this rule, overwriting any previous value.
void	setScopePurpose(ScopePurpose newSP)
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

ScopeRule

public ScopeRule(ScopeMatchConstraint match,
                 ObjectType ot)

Creates a scope rule object.

ScopeRule

public ScopeRule(ScopeMatchConstraint match,
                 ObjectType ot,
                 ScopePurpose sp)

Creates a scope rule object.

ScopeRule

public ScopeRule(ScopeMatchConstraint match,
                 OrgScopeConstraint org,
                 ObjectType ot)

Creates a scope rule object.

Method Detail

getScopeMatchConstraint

public ScopeMatchConstraint getScopeMatchConstraint()

Retrieves the scope match constraint for this rule.

Returns:

The scope match constraint object.

setScopeMatchConstraint

public void setScopeMatchConstraint(ScopeMatchConstraint cons)

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

Parameters:

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

getOrgScopeConstraint

public OrgScopeConstraint getOrgScopeConstraint()

Retrieves the organization scope constraint for this rule.

Returns:

The organization scope constraint object.

setOrgScopeConstraint

public void setOrgScopeConstraint(OrgScopeConstraint cons)

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

Parameters:

cons - The new organization scope 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.

getObjectType

public ObjectType getObjectType()

Retrieves the type of object associated with this scope rule.

Returns:

The type of object associated with the scope rule.

getScopePurpose

public ScopePurpose getScopePurpose()

setScopePurpose

public void setScopePurpose(ScopePurpose newSP)

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.

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object