com.whitestein.lsps.human.function

Class HumanFunctionsImpl

java.lang.Object

com.whitestein.lsps.human.function.HumanFunctionsImpl

All Implemented Interfaces:

HumanFunctions

@PermitAll
public class HumanFunctionsImpl
extends Object
implements HumanFunctions

Functions for Human module.

Author:

pna

Constructor Summary

Constructors

Constructor and Description
HumanFunctionsImpl() Creates new instance.
HumanFunctionsImpl(com.whitestein.lsps.human.ejb.TodoServiceLocal todoService, OrgTypeFactory orgTypeFactory, HumanTypeFactory humanTypeFactory) Creates new instance.

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, 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, 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, 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

HumanFunctionsImpl

public HumanFunctionsImpl()

Creates new instance.

HumanFunctionsImpl

public HumanFunctionsImpl(com.whitestein.lsps.human.ejb.TodoServiceLocal todoService,
                          OrgTypeFactory orgTypeFactory,
                          HumanTypeFactory humanTypeFactory)

Creates new instance.

Parameters:

todoService -

orgTypeFactory -

humanTypeFactory -

Throws:

NullPointerException - if any of the arguments is null

Method Detail

getTodoSubmitter

public RecordHolder getTodoSubmitter(ExecutionContext context,
                                     RecordHolder todo)
                              throws ErrorException

Description copied from interface: HumanFunctions

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

Specified by:

getTodoSubmitter in interface HumanFunctions

Returns:

the person that has submitted given todo

Throws:

ErrorException

getTodoCurrentAssignees

public SetHolder getTodoCurrentAssignees(ExecutionContext context,
                                         RecordHolder todo)
                                  throws ErrorException

Description copied from interface: HumanFunctions

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

Specified by:

getTodoCurrentAssignees in interface HumanFunctions

Returns:

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

Throws:

ErrorException

getTodoPerformers

public SetHolder getTodoPerformers(ExecutionContext context,
                                   RecordHolder todo)
                            throws ErrorException

Description copied from interface: HumanFunctions

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

Specified by:

getTodoPerformers in interface HumanFunctions

Returns:

a set of the original performers of the specified todo

Throws:

ErrorException

getTodosFor

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

Description copied from interface: HumanFunctions

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

Specified by:

getTodosFor in interface HumanFunctions

Returns:

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

Throws:

ErrorException

getTodosFor

public SetHolder getTodosFor(ExecutionContext context,
                             RecordHolder person,
                             Boolean includeAllocatedByOthers)
                      throws ErrorException

Description copied from interface: HumanFunctions

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

Specified by:

getTodosFor in interface HumanFunctions

Returns:

a set of active todos assigned to the specified person

Throws:

ErrorException

getTodosFor

public SetHolder getTodosFor(ExecutionContext context,
                             RecordHolder person)
                      throws ErrorException

Description copied from interface: HumanFunctions

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

Specified by:

getTodosFor in interface HumanFunctions

Returns:

a set of active todos assigned to the specified person

Throws:

ErrorException

unallocateTodo

public void unallocateTodo(ExecutionContext context,
                           RecordHolder todo)
                    throws ErrorException

Description copied from interface: HumanFunctions

Unallocates todo.

Specified by:

unallocateTodo in interface HumanFunctions

Throws:

ErrorException

allocateTodo

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

Description copied from interface: HumanFunctions

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.

Specified by:

allocateTodo in interface HumanFunctions

Throws:

ErrorException

reassignTodo

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

Description copied from interface: HumanFunctions

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

Specified by:

reassignTodo in interface HumanFunctions

Throws:

ErrorException

rejectTodo

public void rejectTodo(ExecutionContext context,
                       RecordHolder todo,
                       SetHolder persons,
                       String reason)

Description copied from interface: HumanFunctions

Reject todo for all specified persons.

Specified by:

rejectTodo in interface HumanFunctions

deleteSavedDocuments

public void deleteSavedDocuments(ExecutionContext context,
                                 SetHolder documents)
                          throws ErrorException

Description copied from interface: HumanFunctions

Deletes the specified saved documents.

Specified by:

deleteSavedDocuments in interface HumanFunctions

Throws:

ErrorException

getUIHistory

public MapHolder getUIHistory(ExecutionContext context)
                       throws ErrorException

Description copied from interface: HumanFunctions

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).

Specified by:

getUIHistory in interface HumanFunctions

Returns:

UI history

Throws:

ErrorException

getCurrentTodo

public RecordHolder getCurrentTodo(ExecutionContext context)

Description copied from interface: HumanFunctions

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

Specified by:

getCurrentTodo in interface HumanFunctions

Returns:

current todo or null, if there is none

resetTodo

public void resetTodo(ExecutionContext ctx,
                      RecordHolder todo)
               throws ErrorException

Description copied from interface: HumanFunctions

Reset state of the todo.

Specified by:

resetTodo in interface HumanFunctions

Throws:

ErrorException

getTodoIdsFor

public SetHolder getTodoIdsFor(ExecutionContext ctx,
                               RecordHolder person,
                               String titlePattern)
                        throws ErrorException

Description copied from interface: HumanFunctions

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

Specified by:

getTodoIdsFor in interface HumanFunctions

Returns:

set of todo ids

Throws:

ErrorException

submit

public ListHolder submit(ExecutionContext ctx)
                  throws ErrorException,
                         OptimisticLockException

Description copied from interface: HumanFunctions

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.

Specified by:

submit in interface HumanFunctions

Returns:

List of newly created todos.

Throws:

ErrorException

OptimisticLockException

persist

public void persist(ExecutionContext ctx)
             throws ErrorException

Specified by:

persist in interface HumanFunctions

Throws:

ErrorException