Interface CMSWorkflowParticipantService
-
- All Known Implementing Classes:
DefaultCMSWorkflowParticipantService
public interface CMSWorkflowParticipantService
Service manage participants in a workflow.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Collection<PrincipalModel>
getRelatedPrincipals(PrincipalModel user)
Finds all principals for the given user.boolean
isActiveWorkflowActionParticipant(WorkflowModel workflow)
Determines if the current session user is a participant of an active action of a workflow.boolean
isParticipantForAttachedItems(java.util.List<? extends CMSItemModel> cmsItems)
Determines if the current session user is a participant of all workflows containing the given CMS items as attachments.boolean
isWorkflowActionParticipant(WorkflowActionModel workflowAction)
Determines if the current session user is a participant of the given workflow.boolean
isWorkflowParticipant(WorkflowModel workflow)
Determines if the current session user is a participant of the given workflow.
-
-
-
Method Detail
-
isWorkflowParticipant
boolean isWorkflowParticipant(WorkflowModel workflow)
Determines if the current session user is a participant of the given workflow.- Parameters:
workflow
- - the workflow template containing the list of participants allowed to interact in the workflow- Returns:
TRUE
when the current user is a participant in the workflow; otherwiseFALSE
-
isParticipantForAttachedItems
boolean isParticipantForAttachedItems(java.util.List<? extends CMSItemModel> cmsItems)
Determines if the current session user is a participant of all workflows containing the given CMS items as attachments.- Parameters:
cmsItems
- - the items saved as attachments to a workflow- Returns:
TRUE
when the current user is a participant in all workflows containing the given items or when the items are not contained in any workflow; otherwiseFALSE
-
isWorkflowActionParticipant
boolean isWorkflowActionParticipant(WorkflowActionModel workflowAction)
Determines if the current session user is a participant of the given workflow.- Parameters:
workflowAction
- - the workflow template containing the list of participants allowed to interact in the workflow- Returns:
TRUE
when the current user is a participant in the workflow action; otherwiseFALSE
-
getRelatedPrincipals
java.util.Collection<PrincipalModel> getRelatedPrincipals(PrincipalModel user)
Finds all principals for the given user. Note that a principal can be a user or a user group.- Parameters:
user
- - the user for whom a list of principals is to be retrieved.- Returns:
- a list of principals.
-
isActiveWorkflowActionParticipant
boolean isActiveWorkflowActionParticipant(WorkflowModel workflow)
Determines if the current session user is a participant of an active action of a workflow.- Parameters:
workflow
- the workflow to verify- Returns:
- TRUE if the workflow has active action and the user is a participant of this action, FALSE otherwise.
-
-