CA Identity Manager
Java SDK r12.5 SP 8

 

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

java.lang.Object
  extended by com.netegrity.llsdk6.imsapi.policy.rule.constraints.OrgScopeConstraint
All Implemented Interfaces:
RuleConstraint, java.lang.Cloneable

public class OrgScopeConstraint
extends java.lang.Object
implements RuleConstraint

Defines a constraint for an organization search scope.

Since:
Identity Manager 8.1

Constructor Summary
OrgScopeConstraint()
           
 
Method Summary
 void addIdentifier(OrgScopeIdentifier identifier)
          Appends a new scope identifier to the constraint.
 java.lang.Object clone()
           
 java.util.Vector getIdentifiers()
          Retrieves the set of scope identifiers that define this constraint.
 java.lang.String marshall()
          Creates a serialized String representation of this constraint which can be used for transmission/storage.
 void setIdentifiers(java.util.Vector identifiers)
          Defines the complete set of OrgScopeIdentifier objects for this constraint.
 boolean wouldMatch(TSContext ctx, ManagedObject obj, java.lang.StringBuffer message)
          Specifies whether the current form of this managed object matches the constraint.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OrgScopeConstraint

public OrgScopeConstraint()
Method Detail

setIdentifiers

public void setIdentifiers(java.util.Vector identifiers)

Defines the complete set of OrgScopeIdentifier objects for this constraint.

An implicit OR exists between identifiers.

This method specifies all the scope identifiers for this constraint. Any existing identifiers are overwritten.

Parameters:
identifiers - A Vector of OrgScopeIdentifier objects.

getIdentifiers

public java.util.Vector getIdentifiers()
Retrieves the set of scope identifiers that define this constraint.

Returns:
A Vector of OrgScopeIdentifier objects.

addIdentifier

public void addIdentifier(OrgScopeIdentifier identifier)

Appends a new scope identifier to the constraint.

Parameters:
identifier - The OrgScopeIdentifier object to add to any existing scope identifiers.

marshall

public java.lang.String marshall()
Description copied from interface: RuleConstraint

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

Specified by:
marshall in interface RuleConstraint
Returns:
A String representation of this constraint.

wouldMatch

public boolean wouldMatch(TSContext ctx,
                          ManagedObject obj,
                          java.lang.StringBuffer message)
                   throws SmApiException
Description copied from interface: RuleConstraint

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

Specified by:
wouldMatch in interface RuleConstraint
Parameters:
ctx - The context in which the constraint is evaluated.
obj - The managed object to check.
message - Output parameter for an exception message.
Returns:
true if the managed object matches the constraint.
Throws:
SmApiException

clone

public java.lang.Object clone()
Specified by:
clone in interface RuleConstraint
Overrides:
clone in class java.lang.Object

CA Identity Manager
Java SDK r12.5 SP 8

06/13/2011

© 2011 CA Technologies, Inc. All rights reserved.