Package de.xima.fc.handler.interfaces.entity

Interface IWorkflowTriggerHandler

All Superinterfaces:

IAPIHandler, IGenericHandler, Serializable

All Known Implementing Classes:

WorkflowTriggerHandler

public interface IWorkflowTriggerHandler
extends IGenericHandler

Handler for WorkflowTrigger entities.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
List<WorkflowTrigger>	getAllUserTriggerByRecordAndUser(UserContext uc, UUID formRecordUuid, IUser user)	Returns all workflow user triggers defined by the given record and user.
BaseWorkflowTriggerDTO	getTriggerByRecordAndUser(UserContext uc, UUID formRecordUuid, IUser user, UUID taskUuid, UUID triggerUuid, Locale locale)	Returns the workflow trigger defined by the given record, task and trigger UUID.
PagedResult<BaseWorkflowTriggerDTO>	getTriggersByRecordAndUser(UserContext uc, UUID formRecordUuid, IUser user, int page, int pageSize, Locale locale)	Returns a paged result of workflow triggers which are available for the given form record and user.
List<BaseWorkflowTriggerDTO>	getTriggersByRecordAndUser(UserContext uc, UUID formRecordUuid, IUser user, Locale locale)	Returns all workflow triggers which are available for the given form record and user.
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 of type FC_USER_INVOCATION., and they must be active.

Parameters:

uc - user context for accessing the database.

formRecordUuid - the UUID of the form record

user - 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 of type FC_USER_INVOCATION, and it must be active.

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

getAllUserTriggerByRecordAndUser

List<WorkflowTrigger> getAllUserTriggerByRecordAndUser(UserContext uc,
                                                       UUID formRecordUuid,
                                                       IUser user)

Returns all workflow user triggers defined by the given record and user. The workflow trigger needs to be of type FC_USER_INVOCATION, and it must be active.

Parameters:

uc - user context for accessing the database.

formRecordUuid - the UUID of the form record.

user - to get the user workflow triggers for.

Returns:

all workflow user triggers defined by the given record and user. null if no workflow

getTriggersByRecordAndUser

List<BaseWorkflowTriggerDTO> getTriggersByRecordAndUser(UserContext uc,
                                                        UUID formRecordUuid,
                                                        IUser user,
                                                        Locale locale)

Returns all workflow triggers which are available for the given form record and user. The workflow trigger needs to be of type FC_USER_INVOCATION, and it must be active.

Parameters:

uc - user context for accessing the database.

formRecordUuid - the UUID of the form record.

user - to get the user workflow triggers for.

locale - the locale to use for the display name.

Returns:

all workflow user triggers DTOs defined by the given record.

getTriggersByRecordAndUser

PagedResult<BaseWorkflowTriggerDTO> getTriggersByRecordAndUser(UserContext uc,
                                                               UUID formRecordUuid,
                                                               IUser user,
                                                               int page,
                                                               int pageSize,
                                                               Locale locale)

Returns a paged result of workflow triggers which are available for the given form record and user. The workflow trigger needs to be of type FC_USER_INVOCATION, and it must be active.

Parameters:

uc - user context for accessing the database.

formRecordUuid - the UUID of the form record.

user - to get the user workflow triggers for.

page - the page to get.

pageSize - the size of the page to get.

locale - the locale to use for the display name.

Returns:

a paged result of workflow user triggers DTOs defined by the given record.

getTriggerByRecordAndUser

BaseWorkflowTriggerDTO getTriggerByRecordAndUser(UserContext uc,
                                                 UUID formRecordUuid,
                                                 IUser user,
                                                 UUID taskUuid,
                                                 UUID triggerUuid,
                                                 Locale locale)

Returns the workflow trigger defined by the given record, task and trigger UUID. The workflow trigger needs to be of type FC_USER_INVOCATION, and it must be active.

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.

locale - the locale to use for the display name.

Returns:

the workflow user trigger defined by the given record, task and trigger UUID.