com.whitestein.lsps.human.function

Interface HumanFunctions

All Known Implementing Classes:

HumanFunctionsImpl

public interface HumanFunctions

Functions provided by this module.

Author:

rba

Method Summary

Modifier and Type	Method and Description
void	allocateTodo(ExecutionContext context, RecordHolder todo, RecordHolder person) Allocates the specified todo to the person.
void	deleteSavedDocuments(ExecutionContext context, SetHolder documents) Deletes the specified saved documents.
RecordHolder	getCurrentTodo(ExecutionContext context) Returns the currently opened to-do.
SetHolder	getTodoCurrentAssignees(ExecutionContext context, RecordHolder todo) Returns a set of persons the specified todo is currently issued (visible) to, taking into account also delegation, rejection and substitution.
SetHolder	getTodoIdsFor(ExecutionContext ctx, RecordHolder person, java.lang.String titlePattern) Returns a set of active todo ids assigned to the specified person according to the criteria.
SetHolder	getTodoPerformers(ExecutionContext context, RecordHolder todo) Returns a set of the original performers of the specified todo, as given by the corresponding task.
SetHolder	getTodosFor(ExecutionContext context, RecordHolder person) Returns a set of active todos assigned to the specified person.
SetHolder	getTodosFor(ExecutionContext context, RecordHolder person, java.lang.Boolean includeAllocatedByOthers) Returns a set of active todos assigned to the specified person.
SetHolder	getTodosFor(ExecutionContext context, RecordHolder person, TodoListCriteria todoListCriteria) Returns a set of active todos assigned to the specified person according to the criteria.
RecordHolder	getTodoSubmitter(ExecutionContext context, RecordHolder todo) If the specified todo is in the "Accomplished" state, the function returns the person who submitted that todo.
MapHolder	getUIHistory(ExecutionContext context) A function which returns UI history.
void	persist(ExecutionContext ctx)
void	reassignTodo(ExecutionContext context, RecordHolder todo, SetHolder performers) Changes the set of performers of the specified todo.
void	rejectTodo(ExecutionContext context, RecordHolder todo, SetHolder persons, java.lang.String reason) Reject todo for all specified persons.
void	resetTodo(ExecutionContext ctx, RecordHolder todo) Reset state of the todo.
ListHolder	submit(ExecutionContext ctx) Submits a form that do not use evaluation levels: Todo Form: Submits todos that do not use evaluation levels.
void	unallocateTodo(ExecutionContext context, RecordHolder todo) Unallocates todo.

Method Detail

getTodoSubmitter

RecordHolder getTodoSubmitter(ExecutionContext context,
                              RecordHolder todo)
                       throws ErrorException

If the specified todo is in the "Accomplished" state, the function returns the person who submitted that todo. Otherwise, the function returns null.

Parameters:

context -

todo -

Returns:

the person that has submitted given todo

Throws:

ErrorException

getTodoCurrentAssignees

SetHolder getTodoCurrentAssignees(ExecutionContext context,
                                  RecordHolder todo)
                           throws ErrorException

Returns a set of persons the specified todo is currently issued (visible) to, taking into account also delegation, rejection and substitution.

Parameters:

context -

todo -

Returns:

a set of persons the specified todo is currently issued (visible) to

Throws:

ErrorException

getTodoPerformers

SetHolder getTodoPerformers(ExecutionContext context,
                            RecordHolder todo)
                     throws ErrorException

Returns a set of the original performers of the specified todo, as given by the corresponding task.

Parameters:

context -

todo -

Returns:

a set of the original performers of the specified todo

Throws:

ErrorException

getTodosFor

SetHolder getTodosFor(ExecutionContext context,
                      RecordHolder person,
                      TodoListCriteria todoListCriteria)
               throws ErrorException

Returns a set of active todos assigned to the specified person according to the criteria.

Parameters:

context -

person -

todoListCriteria -

Returns:

a set of active to-dos assigned to the specified person

Throws:

ErrorException

getTodosFor

SetHolder getTodosFor(ExecutionContext context,
                      RecordHolder person,
                      java.lang.Boolean includeAllocatedByOthers)
               throws ErrorException

Returns a set of active todos assigned to the specified person. It can include todos allocated by other persons.

Parameters:

context -

person -

includeAllocatedByOthers -

Returns:

a set of active todos assigned to the specified person

Throws:

ErrorException

getTodosFor

SetHolder getTodosFor(ExecutionContext context,
                      RecordHolder person)
               throws ErrorException

Returns a set of active todos assigned to the specified person.

Parameters:

context -

person -

Returns:

a set of active todos assigned to the specified person

Throws:

ErrorException

getTodoIdsFor

SetHolder getTodoIdsFor(ExecutionContext ctx,
                        RecordHolder person,
                        java.lang.String titlePattern)
                 throws ErrorException

Returns a set of active todo ids assigned to the specified person according to the criteria.

Parameters:

ctx -

person -

titlePattern -

Returns:

set of todo ids

Throws:

ErrorException

unallocateTodo

void unallocateTodo(ExecutionContext context,
                    RecordHolder todo)
             throws ErrorException

Unallocates todo.

Parameters:

context -

todo -

Throws:

ErrorException

allocateTodo

void allocateTodo(ExecutionContext context,
                  RecordHolder todo,
                  RecordHolder person)
           throws ErrorException

Allocates the specified todo to the person. The given person must belong to the set of persons resolved from the current todo assignees, else an exception is thrown. If the todo is currently allocated to another person, the function performs reallocation.

Parameters:

context -

todo -

person -

Throws:

ErrorException

reassignTodo

void reassignTodo(ExecutionContext context,
                  RecordHolder todo,
                  SetHolder performers)
           throws ErrorException

Changes the set of performers of the specified todo. Possible delegations and allocation of the todo are removed.

Parameters:

context -

todo -

performers -

Throws:

ErrorException

deleteSavedDocuments

void deleteSavedDocuments(ExecutionContext context,
                          SetHolder documents)
                   throws ErrorException

Deletes the specified saved documents.

Parameters:

context -

documents -

Throws:

ErrorException

getUIHistory

MapHolder getUIHistory(ExecutionContext context)
                throws ErrorException

A function which returns UI history. Under key 0 is always "current" page. Under positive keys are older entries (back), under negative keys less old entries (forward).

Parameters:

context -

Returns:

UI history

Throws:

ErrorException

getCurrentTodo

RecordHolder getCurrentTodo(ExecutionContext context)

Returns the currently opened to-do. If the function is not called from the context of a to-do, it returns null.

Parameters:

context -

Returns:

current todo or null, if there is none

resetTodo

void resetTodo(ExecutionContext ctx,
               RecordHolder todo)
        throws ErrorException

Reset state of the todo.

Parameters:

ctx -

todo -

Throws:

ErrorException

rejectTodo

void rejectTodo(ExecutionContext context,
                RecordHolder todo,
                SetHolder persons,
                java.lang.String reason)

Reject todo for all specified persons.

Parameters:

context -

todo -

persons -

reason -

submit

ListHolder submit(ExecutionContext ctx)
           throws ErrorException,
                  OptimisticLockException

Submits a form that do not use evaluation levels:

• Todo Form: Submits todos that do not use evaluation levels. It propagates changes in non-shared records and variables from detached model instance to the persisted model instance. Returns the newly created todos and returns them.
• Document Form: Consults the model instance for the newly created todos and returns them.

Parameters:

ctx -

Returns:

List of newly created todos.

Throws:

ErrorException

OptimisticLockException

persist

void persist(ExecutionContext ctx)
      throws ErrorException

Throws:

ErrorException