com.netegrity.llsdk6.imsapi.policy
Interface MembershipPolicy

All Superinterfaces:

ModifiableObject, Policy, java.io.Serializable

public interface MembershipPolicy
extends Policy

Defines a membership policy for a role.

A membership policy contains:

• The member rule that determines who the members of the role can be.
  To retrieve the member rule from the policy, call getTriggerRule() inherited from Policy.
  
  
• Scope rules that determine the set of objects that can be managed by members of the associated role.
  Scope rules can be defined for the following types of objects:
  • USER
  • GROUP
  • ORG
  • ACCESS_TASK
  To retrieve a scope rule from the policy, call getScopeRule().

Since:

Identity Manager 8.1

See Also:

createMembershipPolicy()

Method Summary

ScopeRule	getScopeRule(ObjectType type) Retrieves the scope rule for the specified managed object type.
ScopeRule	getScopeRule(ObjectType type, ScopePurpose sp) Retrieves the scope rule for the specified managed object type.
java.util.Map	getScopeRules() Get a Map representing all the scope rules in this policy
java.util.Vector	getScopeRules(java.util.Set types, ScopePurpose sp) Retrieves the set of scope rules for the specified managed object type set.
void	removeScopingRule(ObjectType type) Removes the scope rule for the specified managed object type.
void	removeScopingRule(ObjectType type, ScopePurpose sp) Removes the scope rule for the specified managed object type.
void	setScopeRule(ObjectType type, ScopePurpose sp, ScopeRule rule) Sets the scope rule for the specified managed object type.
void	setScopeRule(ObjectType type, ScopeRule rule) Sets the scope rule for the specified managed object type.
java.util.Map	setScopeRules(java.util.Map t) Replaces the set of scope rule for this policy with the ones from the map passed in.

Methods inherited from interface com.netegrity.llsdk6.imsapi.policy.Policy

getMemberRule, getRole, getTriggerRule, setMemberRule, setTriggerRule

Methods inherited from interface com.netegrity.llsdk6.imsapi.abstractinterface.ModifiableObject

modifyObject, modifyObject

Method Detail

getScopeRule

ScopeRule getScopeRule(ObjectType type)

Retrieves the scope rule for the specified managed object type. If a scope rule is not defined for this object type, the method returns null.

Parameters:

type - The type of managed object whose scope rule is being retrieved.

Returns:

The scope rule for this managed object type, or null if no scope rule is defined for this object type.

getScopeRule

ScopeRule getScopeRule(ObjectType type,
                       ScopePurpose sp)

Retrieves the scope rule for the specified managed object type. If a scope rule is not defined for this object type, the method returns null.

Parameters:

type - The type of managed object whose scope rule is being retrieved.

Returns:

The scope rule for this managed object type, or null if no scope rule is defined for this object type.

getScopeRules

java.util.Vector getScopeRules(java.util.Set types,
                               ScopePurpose sp)

Retrieves the set of scope rules for the specified managed object type set. If a scope rule is not defined for this object type, the method returns an empty map.

Parameters:

types - The set of managed ObjectType's whose scope rules are being retrieved.

Returns:

The set of scope rules for the given set of managed object types, or empty Vector if no scope rule is defined for this object type.

setScopeRule

void setScopeRule(ObjectType type,
                  ScopeRule rule)

Sets the scope rule for the specified managed object type.

Parameters:

type - The type of managed object whose scope rule is being set.

rule - The scope rule to set for the managed object type.

setScopeRule

void setScopeRule(ObjectType type,
                  ScopePurpose sp,
                  ScopeRule rule)

Sets the scope rule for the specified managed object type.

Parameters:

type - The type of managed object whose scope rule is being set.

rule - The scope rule to set for the managed object type.

removeScopingRule

void removeScopingRule(ObjectType type)

Removes the scope rule for the specified managed object type. If the policy does not have a scope rule defined for this object type, the method succeeds.

Parameters:

type - The type of managed object whose scope rule is being removed.

removeScopingRule

void removeScopingRule(ObjectType type,
                       ScopePurpose sp)

Removes the scope rule for the specified managed object type. If the policy does not have a scope rule defined for this object type, the method succeeds.

Parameters:

type - The type of managed object whose scope rule is being removed.

setScopeRules

java.util.Map setScopeRules(java.util.Map t)

Replaces the set of scope rule for this policy with the ones from the map passed in.

Parameters:

t - A Map of ObjectType-to-ScopeRule. Keys are ObjectType, and values are scope rules

Returns:

A Map containing the former scope rules of this policy

getScopeRules

java.util.Map getScopeRules()

Get a Map representing all the scope rules in this policy

Returns:

A Map of ObjectType-to-ScopeRule. Keys are ObjectType, and values are scope rules