fuego.papi
Class Participant

java.lang.Object
  fuego.papi.Participant

All Implemented Interfaces:

Serializable

public abstract class Participant

extends Object

implements Serializable

It represents a Participant, it contains the participant metadata.
This information can be obtained from a PAPI session.
Through this object all the role permissions can be asked.

See Also:

ProcessServiceNESession.getParticipant(), Serialized Form

Nested Class Summary

static class

Participant.RoleAssignment

Method Summary

char	compareParticipantCategoryWith(Participant participant, String roleId) Returns if the category relation between the actual participant and the given participant.
String	getMail() Returns the participant e-mail address
String	getName() Returns the participant name
String	getOu() Returns the Organizational Unit of the participant
int	getRoleCategory(String role) Returns The category from this Participant for the given role.
String	getRolePermitions(String roleId) Returns the permissions from this participant for the given role.
String[]	getRoles() This method returns an array with the roles for this participant.
String	getUid() Returns the user Id
boolean	hasAbortPermision(String role) To know if the participant can abort any instance for the given role
boolean	hasExecutePermision(String role) To know if the participant has execution permission for the given role.
boolean	hasRole(String roleId) Returns true if the participiant belongs to the specified role
boolean	hasSendPermision(String role) To know if the participant can send any instance for the given role
boolean	hasSuspendPermision(String role) To know if the participant can suspend any instance for the given role

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getMail

public String getMail()

Returns the participant e-mail address

Returns:

e-mail address

getName

public String getName()

Returns the participant name

Returns:

participant name

getOu

public String getOu()

Returns the Organizational Unit of the participant

Returns:

Organizational Unit

getRoleCategory

public int getRoleCategory(String role)

Returns The category from this Participant for the given role.

Parameters:

role -

Returns:

getRolePermitions

public String getRolePermitions(String roleId)

Returns the permissions from this participant for the given role.

Parameters:

roleId - The roleId

Returns:

getRoles

public String[] getRoles()

This method returns an array with the roles for this participant.

Returns:

array of role names

getUid

public String getUid()

Returns the user Id

Returns:

user id

compareParticipantCategoryWith

public char compareParticipantCategoryWith(Participant participant,
                                           String roleId)

Returns if the category relation between the actual participant and the given participant.

Parameters:

participant -

roleId -

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

hasAbortPermision

public boolean hasAbortPermision(String role)

To know if the participant can abort any instance for the given role

Parameters:

role - : role name.

Returns:

abort permision

hasExecutePermision

public boolean hasExecutePermision(String role)

To know if the participant has execution permission for the given role.

Parameters:

role - : role name.

Returns:

execution permission

hasRole

public boolean hasRole(String roleId)

Returns true if the participiant belongs to the specified role

Parameters:

roleId - role id

Returns:

true if it belongs to the specified role

hasSendPermision

public boolean hasSendPermision(String role)

To know if the participant can send any instance for the given role

Parameters:

role - : role name.

Returns:

send permision

hasSuspendPermision

public boolean hasSuspendPermision(String role)

To know if the participant can suspend any instance for the given role

Parameters:

role - : role name.

Returns:

suspend permision