com.flowable.engage.commons.api

Interface Permissions

All Known Subinterfaces:

Conversation, ConversationEntity

All Known Implementing Classes:

ConversationEntityImpl

public interface Permissions

This interface must be implemented by data objects supporting permissions.

Method Summary

Modifier and Type	Method and Description
String	getAssignedGroupId() Returns the id of the assigned group of this object.
String	getAssigneeId() Returns the id of the assignee of this object.
Set<String>	getCandidateGroupIds() Returns a set view of the optional list of candidate group ids of this object.
Set<String>	getCandidateUserIds() Returns a set view of the optional list of candidate user ids of this object.
String	getOwnerId() Returns the id of the owner of this object, most likely representing the user actually creating it or being created as part of an operation that user executed.

Method Detail

getOwnerId

String getOwnerId()

Returns the id of the owner of this object, most likely representing the user actually creating it or being created as part of an operation that user executed.

Returns:

the id of the user being the owner of this object

getAssigneeId

String getAssigneeId()

Returns the id of the assignee of this object. What the assignee actually represents is up to the objects use cases and implementation.

Returns:

the optional id of the user being the assignee of the object

getAssignedGroupId

String getAssignedGroupId()

Returns the id of the assigned group of this object. What the assigned group actually represents is up to the objects use cases and implementation.

Returns:

the id of the optional assigned group

getCandidateUserIds

Set<String> getCandidateUserIds()

Returns a set view of the optional list of candidate user ids of this object. In most cases, this is used to allow access to the object for a selected list of users.

Returns:

the optional list of candidate user ids attached to this object

getCandidateGroupIds

Set<String> getCandidateGroupIds()

Returns a set view of the optional list of candidate group ids of this object. Like with the list of candidate users, all users being at least a member of one of the candidate groups will also have access to this object.

Returns:

the optional list of candidate group ids attached to this object