Interface IWorkflowTriggerHandler
-
- All Superinterfaces:
IAPIHandler
,IGenericHandler
,Serializable
- All Known Implementing Classes:
WorkflowTriggerHandler
public interface IWorkflowTriggerHandler extends IGenericHandler
Handler forWorkflowTrigger
entities.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WorkflowTrigger
getUserTriggerByRecordAndUser(UserContext uc, UUID formRecordUuid, IUser user, UUID taskUuid, UUID triggerUuid)
Returns the workflow user trigger defined by the given record, task and trigger UUID.PagedResult<WorkflowTrigger>
getUserTriggersByRecordAndUser(UserContext uc, UUID formRecordUuid, IUser user, int page, int pageSize)
Finds the workflow user triggers available for the form record given by its UUID if the given user can access the form record.-
Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler
getName
-
Methods inherited from interface de.xima.fc.handler.interfaces.entity.IGenericHandler
create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update
-
-
-
-
Method Detail
-
getUserTriggersByRecordAndUser
PagedResult<WorkflowTrigger> getUserTriggersByRecordAndUser(UserContext uc, UUID formRecordUuid, IUser user, int page, int pageSize)
Finds the workflow user triggers available for the form record given by its UUID if the given user can access the form record. The workflow triggers need to be oftype
FC_USER_INVOCATION
., and they must beactive
.- Parameters:
uc
- user context for accessing the database.formRecordUuid
- the UUID of the form recorduser
- to get the user workflow triggers for.page
- to get.pageSize
- size of the page to get.- Returns:
- a list of portal workflow triggers the user has access to ordered by their name (asc).
null
if the form record given by the UUID could not be found. - Since:
- 8.2.0
-
getUserTriggerByRecordAndUser
WorkflowTrigger getUserTriggerByRecordAndUser(UserContext uc, UUID formRecordUuid, IUser user, UUID taskUuid, UUID triggerUuid)
Returns the workflow user trigger defined by the given record, task and trigger UUID. The workflow trigger needs to be oftype
FC_USER_INVOCATION
, and it must beactive
.- Parameters:
uc
- user context for accessing the database.formRecordUuid
- the UUID of the form record.user
- to get the user workflow trigger for.taskUuid
- the UUID of the workflow task.triggerUuid
- the UUID of the workflow trigger.- Returns:
- the workflow user trigger defined by the given record, task and trigger UUID.
null
if no workflow trigger was found with the given specification. - Since:
- 8.2.0
-
-