fuego.papi
Class Participant

java.lang.Object
  fuego.papi.Participant

All Implemented Interfaces:

Comparable, Serializable

public abstract class Participant

extends Object

implements Serializable, Comparable

Contains Participant metadata and methods to get permissions and roles.

To get the current Participant for this session, use ProcessServiceNESession.getParticipant(). To get a Participant by its participantUid, use ProcessServiceNESession.getParticipant(String). To search for a Participant, use ProcessServiceNESession.searchParticipantsByName(String).

See Also:

Serialized Form

Nested Class Summary

static class

Participant.RoleAssignment Contains Participant role assignment metadata.

Method Summary

char	compareParticipantCategoryWith(Participant participant, String roleId) Compares the role category of the specified participant and role to this participant.
int	compareTo(Object compare) Compares this object with the specified object for order.
boolean	equals(Object compare) Indicates whether some other object is "equal to" this one.
String	getFirstName() Gets the first name of this participant.
String	getLastName() Gets the last name of this participant.
String	getMail() Gets the e-mail address of this participant.
String	getName() Gets the name (fisrt and last name) of this participant.
String	getOu() Gets the organizational unit of this participant.
int	getRoleCategory(String role) Gets the category from this Participant for the given role.
String	getRolePermitions(String roleId) Gets the permissions from this participant for the given role.
String[]	getRoles() Gets the roles for this participant.
String	getUid() Gets the Uid for this participant.
boolean	hasAbortPermision(String role) Returns true if this participant has abort permissions for the specified role.
boolean	hasDelegatePermission(String role) Returns true if this participant has delegate permissions for the specified role.
boolean	hasEscalatePermission(String role) Returns true if this participant has excalate permissions for the specified role.
boolean	hasExecutePermision(String role) Returns true if this participant has execute permissions for the specified role.
int	hashCode() Gets the hashCode for this participant.
boolean	hasPeerAssignmentPermission(String role) Returns true if this participant has peer assignment permissions for the specified role.
boolean	hasRole(String roleId) Returns true if this participant has the specified role.
abstract boolean	hasRole(String role, String parameter) Returns true if the participant belongs to the abstract role with the given parameter.
boolean	hasSendPermision(String role) Returns true if this participant has route (send) permissions for the specified role.
boolean	hasSuspendPermision(String role) Returns true if this participant has suspend permissions for the specified role.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

hasRole

public abstract boolean hasRole(String role,
                                String parameter)

Returns true if the participant belongs to the abstract role with the given parameter.

Parameters:

role - Abstract role name

parameter - Parameter to check

Returns:

true if it belongs to the abstract role with the given parameter.

getMail

public String getMail()

Gets the e-mail address of this participant.

Returns:

Participant e-mail address

getName

public String getName()

Gets the name (fisrt and last name) of this participant.

Returns:

Participant name.

getFirstName

public String getFirstName()

Gets the first name of this participant.

Returns:

Participant first name.

getLastName

public String getLastName()

Gets the last name of this participant.

Returns:

Participant last name.

getOu

public String getOu()

Gets the organizational unit of this participant.

Returns:

Participant Organizational Unit.

getRoleCategory

public int getRoleCategory(String role)

Gets the category from this Participant for the given role.

Parameters:

role - Role identification to obtain the category.

Returns:

The category in the given role.

getRolePermitions

public String getRolePermitions(String roleId)

Gets the permissions from this participant for the given role.

Role permissions are set per participant in Process Administrator. Each character in the returned String corresponds to a role permission:

• X = Execute
• R = Route
• S = Suspend
• A = Abort
• D = Delegate
• G = Grab
• E = Escalte
• P = Peer Assignment

Parameters:

roleId - The role identification to obtain the permissions.

Returns:

A String which represents the permissions.

getRoles

public String[] getRoles()

Gets the roles for this participant.

Returns:

roles for this participant.

getUid

public String getUid()

Gets the Uid for this participant.

Returns:

Participant Uid.

compareParticipantCategoryWith

public char compareParticipantCategoryWith(Participant participant,
                                           String roleId)

Compares the role category of the specified participant and role to this participant. Role categories are set in Process Administrator.

Parameters:

participant - Participant to compare to this participant.

roleId - role to check for category for participant.

Returns:

'P' if the catergory are the same
'D' if the current participant has higher category than the given Participant
'E' if the current participant has lower category than the given Participant

compareTo

public int compareTo(Object compare)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface Comparable

Parameters:

compare - the Object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

equals

public boolean equals(Object compare)

Indicates whether some other object is "equal to" this one.

Parameters:

compare - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

hasAbortPermision

public boolean hasAbortPermision(String role)

Returns true if this participant has abort permissions for the specified role.

Parameters:

role - role name.

Returns:

true if this participant has abort permissions for the specified role.

hasEscalatePermission

public boolean hasEscalatePermission(String role)

Returns true if this participant has excalate permissions for the specified role.

Parameters:

role - role name

Returns:

true if this participant has excalate permissions for the specified role.

hasDelegatePermission

public boolean hasDelegatePermission(String role)

Returns true if this participant has delegate permissions for the specified role.

Parameters:

role - role name

Returns:

true if this participant has delegate permissions for the specified role.

hasPeerAssignmentPermission

public boolean hasPeerAssignmentPermission(String role)

Returns true if this participant has peer assignment permissions for the specified role.

Parameters:

role - role name

Returns:

true if this participant has peer assignment permissions for the specified role.

hasExecutePermision

public boolean hasExecutePermision(String role)

Returns true if this participant has execute permissions for the specified role.

Parameters:

role - role name

Returns:

true if this participant has execute permissions for the specified role.

hasRole

public boolean hasRole(String roleId)

Returns true if this participant has the specified role.

Parameters:

roleId - role id

Returns:

true if this participant has the specified role.

hasSendPermision

public boolean hasSendPermision(String role)

Returns true if this participant has route (send) permissions for the specified role.

Parameters:

role - role name

Returns:

true if this participant has route (send) permissions for the specified role.

hasSuspendPermision

public boolean hasSuspendPermision(String role)

Returns true if this participant has suspend permissions for the specified role.

Parameters:

role - role name

Returns:

true if this participant has suspend permissions for the specified role.

hashCode

public int hashCode()

Gets the hashCode for this participant.

Returns:

HashCode for this participant.