com.netscape.pm.model
Interface IRole

All Superinterfaces:

IPMElement, ISortable

public interface IRole

extends IPMElement, ISortable

Defines the interface for a group as defined from the builder. IRoles are essentially containers for group members, with the ability to determine their membership lists at run-time for dynamic roles. IRoles are created during application initialization and are managed by the IRoleManager object, which is available as part of the process definition. The users comprising the IRole membership is managed by the IRoleCache object, which serves as a simple reverse lookup mechanism for functions such as worklist (that is, given a user the IRoleCache is able to provide the list of IRoles the user is a member of).

See Also:

IRoleCache, IRoleManager

Field Summary

static java.lang.String

ASSIGNEE The symbolic name given to the built-in assignee role.

Method Summary

boolean	contains(IParticipant p, IProcessInstance pi) Returns true if the role contains the specified participant given the context of the specified process instance.
java.lang.String[]	memberDNs() Deprecated. as of PM 6.0, use members instead
java.lang.String[]	members() Returns the list of user IDs for the participants that belong to this role.

Methods inherited from interface com.netscape.pm.model.IPMElement

dumpState, getDescription, getName, getParent, getPrettyName, getProperty, isLocked, lockObject, postCreation, setParent, setProperties, toString

Methods inherited from interface com.netscape.pm.model.ISortable

compareTo, getEvaluationOrder

Field Detail

ASSIGNEE

public static final java.lang.String ASSIGNEE

The symbolic name given to the built-in assignee role.

See Also:

IAccessControlManager

Since:

PAE 4.0

Method Detail

contains

public boolean contains(IParticipant p,
                        IProcessInstance pi)
                 throws PMException

Returns true if the role contains the specified participant given the context of the specified process instance.

Parameters:

p - the participant to search the role for

pi - the process instance to establish context

Returns:

true if the role contains the specified participant; false otherwise.

Throws:

PMException - if there is a problem resolving the role's membership roster.

Since:

PAE 4.0

See Also:

IParticipant, IProcessInstance

memberDNs

public java.lang.String[] memberDNs()
                             throws PMException

Deprecated. as of PM 6.0, use members instead

Returns the list of DN of the participants that belongs to this role. As of PAE 6.0, the engine will no longer be using DNs to uniquely identify users in the system. The use of DNs in previous versions led to workitem assignment resolution problems and was fairly clumsy in coding assignment scripts. Instead users will be identified by their user ids. Due to this change, this method has been marked for deprecation as of PAE 6.0. Users should use the method members instead.

Returns:

java.util.String array of DNs (distinguished names) of the participants that belong to this role.

Throws:

PMException - if there is a problem resolving the role's membership roster.

Since:

PAE 4.0

See Also:

members()

members

public java.lang.String[] members()
                           throws PMException

Returns the list of user IDs for the participants that belong to this role.

Returns:

java.util.String array of user ids of the participants that belong to this role.

Throws:

PMException -

Since:

PM 6.0