fuego.papi
Class Participant

java.lang.Object
  fuego.papi.Participant

All Implemented Interfaces:

Serializable, Comparable<Participant>

public abstract class Participant
extends Object
implements Serializable, Comparable<Participant>

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:

ProcessServiceSession.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.
int	compareTo(Participant participant)
boolean	equals(Object compare)
String	getFirstName() Returns the participant first name
String	getLastName() Returns the participant last name
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) Deprecated. use hasAbortPermission(String) instead
boolean	hasAbortPermission(String role) To know if the participant can abort any instance for the given role
boolean	hasDelegatePermission(String role) To know if the participant can delegate any instance for the given role
boolean	hasEscalatePermission(String role) To know if the participant can escalate any instance for the given role
boolean	hasExecutePermision(String role) Deprecated. use hasExecutePermission(String) instead
boolean	hasExecutePermission(String role) To know if the participant has execution permission for the given role.
int	hashCode()
boolean	hasPeerAssignmentPermission(String role) To know if the participant can reassign to a peer any instance for the given role
boolean	hasReassignPermission(String role) To know if the participant can reassign any instance for the given role
boolean	hasRole(String roleId) Returns true if the participiant belongs to the specified role
abstract boolean	hasRole(String role, String parameter) Returns true if the participiant belongs to the specified role
boolean	hasSendPermision(String role) Deprecated. use hasSendPermision(String) instead
boolean	hasSendPermission(String role) To know if the participant can send any instance for the given role
boolean	hasSuspendPermision(String role) Deprecated. use hasSuspendPermission(String) instead
boolean	hasSuspendPermission(String role) To know if the participant can suspend any instance for the given 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 participiant belongs to the specified role

Parameters:

role - role name

parameter - role parameter

Returns:

true if it belongs to the specified role

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

getFirstName

public String getFirstName()

Returns the participant first name

Returns:

participant first name

getLastName

public String getLastName()

Returns the participant last name

Returns:

participant last 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 - Role identification to obtain the category.

Returns:

The category in the given role.

getRolePermitions

public String getRolePermitions(String roleId)

Returns the permissions from this participant for the given role.

Parameters:

roleId - The role identification to obtain the permissions.

Returns:

A String which represents the permissions.

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

compareTo

public int compareTo(Participant participant)

Specified by:

compareTo in interface Comparable<Participant>

equals

public boolean equals(Object compare)

Overrides:

equals in class Object

hasAbortPermision

@Deprecated
public boolean hasAbortPermision(String role)

Deprecated. use hasAbortPermission(String) instead

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

Parameters:

role - The role identification to check permission.

Returns:

true if the participant has the abort permission in the given role.

hasAbortPermission

public boolean hasAbortPermission(String role)

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

Parameters:

role - The role identification to check permission.

Returns:

true if the participant has the abort permission in the given role.

hasExecutePermision

@Deprecated
public boolean hasExecutePermision(String role)

Deprecated. use hasExecutePermission(String) instead

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

Parameters:

role - The role identification to check permission.

Returns:

true if the participant has the execute permission in the given role.

hasExecutePermission

public boolean hasExecutePermission(String role)

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

Parameters:

role - The role identification to check permission.

Returns:

true if the participant has the execute permission in the given role.

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

@Deprecated
public boolean hasSendPermision(String role)

Deprecated. use hasSendPermision(String) instead

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

Parameters:

role - The role identification to check permission.

Returns:

true if the participant has the send permission in the given role.

hasSendPermission

public boolean hasSendPermission(String role)

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

Parameters:

role - The role identification to check permission.

Returns:

true if the participant has the send permission in the given role.

hasReassignPermission

public boolean hasReassignPermission(String role)

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

Parameters:

role - The role identification to check permission.

Returns:

true if the participant has the reassign permission in the given role.

hasPeerAssignmentPermission

public boolean hasPeerAssignmentPermission(String role)

To know if the participant can reassign to a peer any instance for the given role

Parameters:

role - The role identification to check permission.

Returns:

true if the participant has the peer assignment permission in the given role.

hasEscalatePermission

public boolean hasEscalatePermission(String role)

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

Parameters:

role - The role identification to check permission.

Returns:

true if the participant has the escalate permission in the given role.

hasDelegatePermission

public boolean hasDelegatePermission(String role)

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

Parameters:

role - The role identification to check permission.

Returns:

true if the participant has the delegate permission in the given role.

hasSuspendPermision

@Deprecated
public boolean hasSuspendPermision(String role)

Deprecated. use hasSuspendPermission(String) instead

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

Parameters:

role - The role identification to check permission.

Returns:

true if the participant has the suspend permission in the given role.

hasSuspendPermission

public boolean hasSuspendPermission(String role)

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

Parameters:

role - The role identification to check permission.

Returns:

true if the participant has the suspend permission in the given role.

hashCode

public int hashCode()

Overrides:

hashCode in class Object