Package de.xima.fc.api.entity

Class WorkflowTaskAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.AEntityAPI<WorkflowTask>

de.xima.fc.api.entity.WorkflowTaskAPI

public class WorkflowTaskAPI
extends AEntityAPI<WorkflowTask>

API class for reading and writing WorkflowTask entities.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields inherited from class de.xima.fc.api.entity.AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor	Description
WorkflowTaskAPI()

Method Summary

Modifier and Type	Method	Description
List<WorkflowTask>	getInboxTasks(UserContext uc, Vorgang formRecord, Benutzer user)	Deprecated. Use getInboxTasks(UserContext, Vorgang, IUser) instead.
List<WorkflowTask>	getInboxTasks(UserContext uc, Vorgang formRecord, IUser user)	Finds all tasks that are allowed to be invoked by the given user in the inbox.
boolean	isTaskInvokableInInbox(UserContext uc, WorkflowTask task, Vorgang formRecord, Benutzer user)	Deprecated. Use isTaskInvokableInInbox(UserContext, WorkflowTask, Vorgang, IUser) instead.
boolean	isTaskInvokableInInbox(UserContext uc, WorkflowTask task, Vorgang formRecord, IUser user)	Checks whether the given task may be initiated by the given user in the inbox.

Methods inherited from class de.xima.fc.api.entity.AEntityAPI

create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getEntityRefs, getPagedResult, getSingleAttributes, getSingleAttributes, resultTotalCount, resultTotalCount, update, update

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowTaskAPI

public WorkflowTaskAPI()

Method Detail

getInboxTasks

public List<WorkflowTask> getInboxTasks(UserContext uc,
                                        Vorgang formRecord,
                                        IUser user)

Finds all tasks that are allowed to be invoked by the given user in the inbox.

Parameters:

uc - Current user context for database transactions.

formRecord - Form record for which to find the tasks.

user - User for checking permissions.

Returns:

A list of all invokable tasks for the given form record, restricted to the tasks permitted to the given user. The WorkflowTask.getTrigger() field will be initialized.

isTaskInvokableInInbox

public boolean isTaskInvokableInInbox(UserContext uc,
                                      WorkflowTask task,
                                      Vorgang formRecord,
                                      IUser user)

Checks whether the given task may be initiated by the given user in the inbox.

Parameters:

uc - Current user context for database transactions.

task - A workflow task to check.

formRecord - Form record for which to find the tasks.

user - User for checking permissions.

Returns:

true if the given user is permitted to initiated the given task, or false otherwise.

getInboxTasks

@Deprecated
public List<WorkflowTask> getInboxTasks(UserContext uc,
                                        Vorgang formRecord,
                                        Benutzer user)

Deprecated.

Use getInboxTasks(UserContext, Vorgang, IUser) instead.

Finds all tasks that are allowed to be invoked by the given user in the inbox.

Parameters:

uc - Current user context for database transactions.

formRecord - Form record for which to find the tasks.

user - User for checking permissions.

Returns:

A list of all invokable tasks for the given form record, restricted to the tasks permitted to the given user. The WorkflowTask.getTrigger() field will be initialized.

isTaskInvokableInInbox

@Deprecated
public boolean isTaskInvokableInInbox(UserContext uc,
                                      WorkflowTask task,
                                      Vorgang formRecord,
                                      Benutzer user)

Deprecated.

Use isTaskInvokableInInbox(UserContext, WorkflowTask, Vorgang, IUser) instead.

Checks whether the given task may be initiated by the given user in the inbox.

Parameters:

uc - Current user context for database transactions.

task - A workflow task to check.

formRecord - Form record for which to find the tasks.

user - User for checking permissions.

Returns:

true if the given user is permitted to initiated the given task, or false otherwise.