com.whitestein.lsps.human

Interface TodoService

All Known Subinterfaces:

TodoServiceRemote

All Known Implementing Classes:

TodoServiceBean

public interface TodoService

Service for accessing the functionality related to to-dos. The application should use this service to get to-dos for a user and to submit, save and cancel to-dos.

Method Summary

Modifier and Type	Method and Description
void	delegate(long todoId, Collection<String> delegates) Delegates the to-do identified by its ID to a given set of delegates identified by their ID-s.
void	escalateTodo(long todoId, String reason) Escalates to-do.
Collection<Person>	getAllOnBehalfOf(long todoId, String personId) Returns the set of persons on behalf of which the user sees the to-do in his to-do list.
TodoAuthorization	getAuthorization(long todoId, String personId) Returns the reason why the person can see the to-do in his to-do list.
CompressedData	getCompressedTodoSavedState(long todoId) Returns the content of a saved to-do.
Collection<Person>	getCurrentAssignees(long todoId) Find current assignees for a to-do specified by its ID.
TodoEscalation	getEscalation(long escalationId) Returns todo escalation for the given id.
Collection<TodoEscalation>	getEscalations(long todoId) Returns a collection of todo escalations.
Todo	getLockedTodo(long todoId) Returns the to-do for the given ID including the to-do content and its performers.
TodoList	getPersonalTodoList(PagingCriteria criteria) Returns the personal list for the current user, the to-dos do not contain the to-do content nor the to-do performers.
Collection<Person>	getRejecters(long todoId) Gets persons who reject to-do specified by its ID.
Collection<TodoRejection>	getRejections(long todoId) Gets rejections for to-do specified by its ID.
Todo	getTodo(long todoId) Returns the to-do for the given ID including the to-do content and its performers.
long	getTodoCount(TodoListCriteria criteria) Returns the count of to-dos relevant for the current user.
TodoList	getTodoList(TodoListCriteria criteria) Returns the list of to-dos relevant for the current user.
TodoList	getTodoListForPerson(String personId, TodoListCriteria criteria) Returns the list of to-dos relevant for the user identified by the given id.
List<Long>	getTodoListIdsForPerson(String personId, TodoListCriteria criteria) Returns the list of to-dos ids relevant for the user identified by the given id.
ByteData	getTodoSavedState(long todoId) Returns the content of a saved to-do.
Todo	getTodoWithIncludes(long todoId, boolean includeContent, boolean includePerformers) Returns the to-do for the given ID.
boolean	isUserRejected(long todoId, String personId) Returns true if a todo is rejected by a user.
void	lockTodo(long todoId) Locks the to-do.
void	lockTodoForPerson(long todoId, String personId) Locks the to-do for the given person.
void	reassign(long todoId, PerformerList performers) Reassigns todo to new performers.
void	rejectAnyTodoForPerson(long todoId, String personId, String reason, boolean rejectInaccessible) Rejects a to-do specified by its ID by a user, with some reason.
void	rejectTodo(long todoId, String reason) Rejects a to-do specified by its ID by a user that is currently logged in, with some reason.
void	rejectTodoForPerson(long todoId, String personId, String reason) Rejects a to-do specified by its ID by a user, with some reason.
void	resetTodo(long todoId) Resets to-do state.
void	saveTodo(long todoId, ByteData data) Saves to-do.
TodoList	searchTodos(TodoCriteria criteria) Returns the list of to-dos for the given criteria.
TodoList	sendSignalToModelInstance(long modelInstanceId, ObjectValue signal) Sends a signal to the process and returns next to-do group.
TodoList	sendSignalToModelInstanceInNewTransaction(long modelInstanceId, ObjectValue signal) Sends a signal to the process and returns next to-do group.
TodoList	sendSignalToModelInstanceWithDeadlockRetry(long modelInstanceId, ObjectValue signal) Sends a signal to the process and returns next to-do group.
void	setCompressedTodoSavedState(long todoId, CompressedData data) Sets the todo saved state.
void	setNotes(long todoId, String notes) Sets notes to the todo
void	setPriority(long todoId, Integer priority) Sets priority of the todo in personal todo list
void	setTodoSavedState(long todoId, ByteData data) Sets the todo saved state.
TodoList	startInterpretModelInstance(long modelInstanceId) Starts the interpretation of an existing process for given process ID.
TodoList	startInterpretModelInstanceInNewTransaction(long modelInstanceId) Starts the interpretation of an existing process for given process ID.
TodoList	startInterpretModelInstanceWithDeadlockRetry(long modelInstanceId) Starts the interpretation of an existing process for given process ID.
TodoList	submitTodo(long todoId, ByteData data) Submits the to-do and returns the next to-do group.
TodoList	submitTodoInNewTransaction(long todoId, ByteData data) Submits the to-do and returns the next to-do group.
TodoList	submitTodoWithDeadlockRetry(long todoId, ByteData data) Submits the to-do and returns the next to-do group.
void	undoDelegation(long todoId) Undo the to-do delegation for a to-do specified by its ID.
void	undoRejectTodo(long todoId, String personId) Undo the rejection of a to-do specified by its ID, by a person specified by its id.
void	unlockTodo(long todoId) Unlocks to-do.

Method Detail

getTodo

Todo getTodo(long todoId)

Returns the to-do for the given ID including the to-do content and its performers.

Parameters:

todoId - to-do ID

Returns:

the to-do for the given ID

getTodoWithIncludes

Todo getTodoWithIncludes(long todoId,
                         boolean includeContent,
                         boolean includePerformers)

Returns the to-do for the given ID. Optionally includes to-do content and its performers.

Parameters:

todoId - to-do ID

includeContent -

includePerformers -

Returns:

the to-do for the given ID

getLockedTodo

Todo getLockedTodo(long todoId)
            throws TodoAllocatedException

Returns the to-do for the given ID including the to-do content and its performers. The to-do will be locked (allocated) to the current user if it is still alive.

Parameters:

todoId - to-do ID

Returns:

the to-do for the given ID

Throws:

TodoAllocatedException

lockTodo

void lockTodo(long todoId)
       throws TodoNotFoundException,
              TodoAllocatedException,
              InvalidTodoStatusException

Locks the to-do. The to-do will be visible only in the to-do list of the current user.

Parameters:

todoId - to-do ID

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

TodoAllocatedException - if the to-do is already allocated to another person

InvalidTodoStatusException - if the to-do is not alive

lockTodoForPerson

void lockTodoForPerson(long todoId,
                       String personId)
                throws TodoNotFoundException,
                       TodoAllocatedException,
                       InvalidTodoStatusException,
                       PersonNotFoundException

Locks the to-do for the given person. The to-do will be visible only in the to-do list of the given person.

Parameters:

todoId - to-do ID

personId - person ID which will have the to-do locked

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

TodoAllocatedException - if the to-do is already allocated to another person

InvalidTodoStatusException - if the to-do is not alive

PersonNotFoundException - if the person with a given id does not exist

startInterpretModelInstance

@RequestWrapper(className="com.whitestein.lsps.human.todo.StartInterpretModelInstance")
TodoList startInterpretModelInstance(long modelInstanceId)
                                                                                                                      throws ModelInstanceNotFoundException,
                                                                                                                             InvalidModelInstanceStateException,
                                                                                                                             ErrorException

Starts the interpretation of an existing process for given process ID. Returns a list of to-dos visible to the current user which were created during the current request.

Parameters:

modelInstanceId - process ID

Returns:

a list of to-dos

Throws:

ErrorException

InvalidModelInstanceStateException

ModelInstanceNotFoundException

startInterpretModelInstanceWithDeadlockRetry

@RequestWrapper(className="com.whitestein.lsps.human.todo.StartInterpretModelInstanceWithDeadlockRetry")
TodoList startInterpretModelInstanceWithDeadlockRetry(long modelInstanceId)
                                                                                                                                                        throws ModelInstanceNotFoundException,
                                                                                                                                                               InvalidModelInstanceStateException,
                                                                                                                                                               ErrorException,
                                                                                                                                                               LspsException

Starts the interpretation of an existing process for given process ID. Returns a list of to-dos visible to the current user which were created during the current request. The action is executed in a new transaction with retry in case of deadlock.

Parameters:

modelInstanceId - process ID

Returns:

a list of to-dos

Throws:

ErrorException

InvalidModelInstanceStateException

ModelInstanceNotFoundException

LspsException

startInterpretModelInstanceInNewTransaction

@RequestWrapper(className="com.whitestein.lsps.human.todo.StartInterpretModelInstanceInNewTransaction")
TodoList startInterpretModelInstanceInNewTransaction(long modelInstanceId)
                                                                                                                                                      throws ModelInstanceNotFoundException,
                                                                                                                                                             InvalidModelInstanceStateException,
                                                                                                                                                             ErrorException

Starts the interpretation of an existing process for given process ID. Returns a list of to-dos visible to the current user which were created during the current request. Method is invoked in a new transaction.

Parameters:

modelInstanceId - process ID

Returns:

a list of to-dos

Throws:

ErrorException

InvalidModelInstanceStateException

ModelInstanceNotFoundException

sendSignalToModelInstance

TodoList sendSignalToModelInstance(long modelInstanceId,
                                   ObjectValue signal)
                            throws ModelInstanceNotFoundException,
                                   InvalidModelInstanceStateException,
                                   ErrorException

Sends a signal to the process and returns next to-do group. Returns a list of to-dos visible to the current user which were created during the current request.

Parameters:

modelInstanceId - model instance ID

signal - signal to be sent to the process

Returns:

to-do group to be shown to the user or null

Throws:

ErrorException

InvalidModelInstanceStateException

ModelInstanceNotFoundException

sendSignalToModelInstanceWithDeadlockRetry

TodoList sendSignalToModelInstanceWithDeadlockRetry(long modelInstanceId,
                                                    ObjectValue signal)
                                             throws ModelInstanceNotFoundException,
                                                    InvalidModelInstanceStateException,
                                                    ErrorException,
                                                    LspsException

Sends a signal to the process and returns next to-do group. Returns a list of to-dos visible to the current user which were created during the current request. The action is executed in a new transaction with retry in case of deadlock.

Parameters:

modelInstanceId - model instance ID

signal - signal to be sent to the process

Returns:

to-do group to be shown to the user or null

Throws:

ErrorException

InvalidModelInstanceStateException

ModelInstanceNotFoundException

LspsException

sendSignalToModelInstanceInNewTransaction

TodoList sendSignalToModelInstanceInNewTransaction(long modelInstanceId,
                                                   ObjectValue signal)
                                            throws ModelInstanceNotFoundException,
                                                   InvalidModelInstanceStateException,
                                                   ErrorException

Sends a signal to the process and returns next to-do group. Returns a list of to-dos visible to the current user which were created during the current request. Method is invoked in a new transaction.

Parameters:

modelInstanceId - model instance ID

signal - signal to be sent to the process

Returns:

to-do group to be shown to the user or null

Throws:

ErrorException

InvalidModelInstanceStateException

ModelInstanceNotFoundException

submitTodo

TodoList submitTodo(long todoId,
                    ByteData data)
             throws TodoNotFoundException,
                    InvalidTodoStatusException,
                    TodoNotAllocatedException,
                    TodoAllocatedException,
                    ErrorException

Submits the to-do and returns the next to-do group. Returns a list of to-dos visible to the current user which were created during the current request.

Parameters:

todoId - to-do ID

data - data entered by user in the web page, may be null.

Returns:

to-do group to be shown to the user, not null, may be empty.

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

InvalidTodoStatusException - if the to-do is not alive anymore

TodoAllocatedException - if the to-do is allocated to another person

TodoNotAllocatedException - if the to-do is not allocated to the current person

ErrorException - if there is an error processing the to-do

submitTodoWithDeadlockRetry

TodoList submitTodoWithDeadlockRetry(long todoId,
                                     ByteData data)
                              throws TodoNotFoundException,
                                     InvalidTodoStatusException,
                                     TodoNotAllocatedException,
                                     TodoAllocatedException,
                                     ErrorException,
                                     LspsException

Submits the to-do and returns the next to-do group. Returns a list of to-dos visible to the current user which were created during the current request. The action is executed in a new transaction with retry in case of deadlock.

Parameters:

todoId - to-do ID

data - data entered by user in the web page

Returns:

to-do group to be shown to the user or null

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

InvalidTodoStatusException - if the to-do is not alive anymore

TodoAllocatedException - if the to-do is allocated to another person

TodoNotAllocatedException - if the to-do is not allocated to the current person

ErrorException - if there is an error processing the to-do

LspsException

submitTodoInNewTransaction

TodoList submitTodoInNewTransaction(long todoId,
                                    ByteData data)
                             throws TodoNotFoundException,
                                    InvalidTodoStatusException,
                                    TodoNotAllocatedException,
                                    TodoAllocatedException,
                                    ErrorException

Submits the to-do and returns the next to-do group. Returns a list of to-dos visible to the current user which were created during the current request. Method is invoked in a new transaction.

Parameters:

todoId - to-do ID

data - data entered by user in the web page

Returns:

to-do group to be shown to the user or null

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

InvalidTodoStatusException - if the to-do is not alive anymore

TodoAllocatedException - if the to-do is allocated to another person

TodoNotAllocatedException - if the to-do is not allocated to the current person

ErrorException - if there is an error processing the to-do

saveTodo

void saveTodo(long todoId,
              ByteData data)
       throws TodoNotFoundException,
              InvalidTodoStatusException,
              TodoNotAllocatedException,
              TodoAllocatedException

Saves to-do. The to-do will appear again in the to-do lists of all associated performers.

Parameters:

todoId - to-do ID

data - user-entered values

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

InvalidTodoStatusException - if the to-do is not alive anymore

TodoAllocatedException - if the to-do is allocated to another person

TodoNotAllocatedException - if the to-do is not allocated to the current person

resetTodo

void resetTodo(long todoId)
        throws TodoNotFoundException

Resets to-do state.

Parameters:

todoId -

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

unlockTodo

void unlockTodo(long todoId)
         throws TodoNotFoundException,
                InvalidTodoStatusException

Unlocks to-do. The to-do will appear again in the to-do lists of all associated performers.

Parameters:

todoId - to-do ID

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

InvalidTodoStatusException

getTodoList

TodoList getTodoList(TodoListCriteria criteria)

Returns the list of to-dos relevant for the current user.

Parameters:

criteria -

Returns:

list of to-dos

Throws:

NullPointerException - if criteria is null

getTodoCount

long getTodoCount(TodoListCriteria criteria)

Returns the count of to-dos relevant for the current user.

Parameters:

criteria -

Returns:

a count of to-dos

Throws:

NullPointerException - if criteria is null

getTodoListForPerson

TodoList getTodoListForPerson(String personId,
                              TodoListCriteria criteria)
                       throws PersonNotFoundException

Returns the list of to-dos relevant for the user identified by the given id.

Parameters:

personId - the id of a person

criteria -

Returns:

list of to-dos

Throws:

NullPointerException - if personId or criteria is null

PersonNotFoundException - if no person with the given personId exists

getTodoListIdsForPerson

List<Long> getTodoListIdsForPerson(String personId,
                                   TodoListCriteria criteria)
                            throws PersonNotFoundException

Returns the list of to-dos ids relevant for the user identified by the given id.

Parameters:

personId -

criteria -

Returns:

list of todo ids

Throws:

PersonNotFoundException

searchTodos

TodoList searchTodos(TodoCriteria criteria)

Returns the list of to-dos for the given criteria.

Parameters:

criteria - to-do criteria

Returns:

list of to-dos

Throws:

NullPointerException - if criteria is null

getPersonalTodoList

TodoList getPersonalTodoList(PagingCriteria criteria)

Returns the personal list for the current user, the to-dos do not contain the to-do content nor the to-do performers.

Parameters:

criteria - paging criteria

Returns:

list of personal to-dos

Throws:

NullPointerException - if criteria is null

escalateTodo

void escalateTodo(long todoId,
                  String reason)
           throws TodoNotFoundException,
                  InvalidTodoStatusException,
                  ErrorException

Escalates to-do.

Parameters:

todoId - to-do ID

reason - reason of escalation

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

InvalidTodoStatusException - if the to-do is not alive anymore

ErrorException

rejectTodo

void rejectTodo(long todoId,
                String reason)
         throws TodoNotFoundException,
                InvalidTodoStatusException

Rejects a to-do specified by its ID by a user that is currently logged in, with some reason.

Parameters:

todoId - to-do ID

reason - reason of rejection

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

InvalidTodoStatusException - if the to-do is not alive anymore

rejectTodoForPerson

void rejectTodoForPerson(long todoId,
                         String personId,
                         String reason)
                  throws TodoNotFoundException,
                         InvalidTodoStatusException

Rejects a to-do specified by its ID by a user, with some reason.

Parameters:

todoId - to-do ID

personId -

reason - reason of rejection

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

InvalidTodoStatusException - if the to-do is not alive anymore

rejectAnyTodoForPerson

void rejectAnyTodoForPerson(long todoId,
                            String personId,
                            String reason,
                            boolean rejectInaccessible)
                     throws TodoNotFoundException,
                            InvalidTodoStatusException

Rejects a to-do specified by its ID by a user, with some reason.

Parameters:

todoId - to-do ID

personId -

reason - reason of rejection

rejectInaccessible - if true todos for that the current person can't access can be rejected

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

InvalidTodoStatusException - if the to-do is not alive anymore

undoRejectTodo

void undoRejectTodo(long todoId,
                    String personId)
             throws TodoNotFoundException,
                    InvalidTodoStatusException,
                    PersonNotFoundException

Undo the rejection of a to-do specified by its ID, by a person specified by its id.

Parameters:

todoId - to-do ID

personId - id of person who rejected the to-do

Throws:

NullPointerException - if personId is null

TodoNotFoundException - if no to-do exists for the given todoId

InvalidTodoStatusException - if the to-do is not alive anymore

PersonNotFoundException - if no person with the given id exists

getRejecters

Collection<Person> getRejecters(long todoId)
                         throws TodoNotFoundException

Gets persons who reject to-do specified by its ID.

Parameters:

todoId - to-do ID

Returns:

set of persons that reject the to-do

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

getRejections

Collection<TodoRejection> getRejections(long todoId)
                                 throws TodoNotFoundException

Gets rejections for to-do specified by its ID.

Parameters:

todoId - to-do ID

Returns:

set of TodoRejections for the to-do

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

getEscalation

TodoEscalation getEscalation(long escalationId)
                      throws TodoEscalationNotFoundException

Returns todo escalation for the given id.

Parameters:

escalationId -

Returns:

todo escalation for the given id

Throws:

TodoEscalationNotFoundException

getEscalations

Collection<TodoEscalation> getEscalations(long todoId)
                                   throws TodoNotFoundException

Returns a collection of todo escalations.

Parameters:

todoId -

Returns:

a collection of todo escalations

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

delegate

void delegate(long todoId,
              Collection<String> delegates)
       throws TodoNotFoundException,
              InvalidTodoStatusException,
              PersonNotFoundException

Delegates the to-do identified by its ID to a given set of delegates identified by their ID-s.

Parameters:

todoId - to-do ID

delegates - Set of delegate's ID-s

Throws:

NullPointerException - if delegates or any element of delegates is null

TodoNotFoundException - if no to-do exists for the given todoId

InvalidTodoStatusException - if the to-do is not alive anymore

PersonNotFoundException - if no person with the given delegates exist

undoDelegation

void undoDelegation(long todoId)
             throws TodoNotFoundException,
                    InvalidTodoStatusException

Undo the to-do delegation for a to-do specified by its ID. Does nothing if at delegation level 0.

Parameters:

todoId - to-do ID

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

InvalidTodoStatusException

reassign

void reassign(long todoId,
              PerformerList performers)
       throws TodoNotFoundException,
              InvalidTodoStatusException

Reassigns todo to new performers.

Parameters:

todoId -

performers -

Throws:

TodoNotFoundException

InvalidTodoStatusException

getCurrentAssignees

Collection<Person> getCurrentAssignees(long todoId)
                                throws TodoNotFoundException

Find current assignees for a to-do specified by its ID. Only initial performers and delegation is taken into account. The resulting persons contain also first level substitutions.

Parameters:

todoId - to-do ID

Returns:

set of assignees

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

getAuthorization

TodoAuthorization getAuthorization(long todoId,
                                   String personId)
                            throws TodoNotFoundException,
                                   PersonNotFoundException

Returns the reason why the person can see the to-do in his to-do list.

Parameters:

todoId - to-do ID

personId - ID of person

Returns:

authorization information

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

PersonNotFoundException - if no person exists for the given personId

getAllOnBehalfOf

Collection<Person> getAllOnBehalfOf(long todoId,
                                    String personId)
                             throws TodoNotFoundException,
                                    PersonNotFoundException

Returns the set of persons on behalf of which the user sees the to-do in his to-do list. If the to-do is in the user's to-do list because he is a substitute of some other users (see getAuthorization(long, String)), this method returns the set of the to-do performers that have this user as their substitute. If the to-do is in the user's to-do list because it was delegated to him, this method returns the person that performed the delegation. In other cases an empty set will be returned.

Parameters:

todoId -

personId -

Returns:

set of persons on behalf of which the user sees the to-do in his to-do list

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

PersonNotFoundException - if no person exists for the given personId

setPriority

void setPriority(long todoId,
                 Integer priority)
          throws TodoNotFoundException,
                 InvalidTodoStatusException,
                 TodoNotAllocatedException,
                 TodoAllocatedException

Sets priority of the todo in personal todo list

Parameters:

todoId -

priority -

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

InvalidTodoStatusException - if the to-do is not alive anymore

TodoAllocatedException - if the to-do is allocated to another person

TodoNotAllocatedException - if the to-do is not allocated to the current person

setNotes

void setNotes(long todoId,
              String notes)
       throws TodoNotFoundException,
              InvalidTodoStatusException,
              TodoNotAllocatedException,
              TodoAllocatedException

Sets notes to the todo

Parameters:

todoId -

notes -

Throws:

TodoNotFoundException - if no to-do exists for the given todoId

InvalidTodoStatusException - if the to-do is not alive anymore

TodoAllocatedException - if the to-do is allocated to another person

TodoNotAllocatedException - if the to-do is not allocated to the current person

IllegalArgumentException - if notes is too long

isUserRejected

boolean isUserRejected(long todoId,
                       String personId)

Returns true if a todo is rejected by a user.

Parameters:

todoId -

personId -

Returns:

true if a todo is rejected by a user

getTodoSavedState

ByteData getTodoSavedState(long todoId)

Returns the content of a saved to-do.

Parameters:

todoId - to-do ID

Returns:

the content data

getCompressedTodoSavedState

CompressedData getCompressedTodoSavedState(long todoId)

Returns the content of a saved to-do.

Parameters:

todoId - to-do ID

Returns:

the content data

setTodoSavedState

void setTodoSavedState(long todoId,
                       ByteData data)
                throws TodoNotFoundException,
                       InvalidTodoStatusException

Sets the todo saved state.

Parameters:

todoId -

data -

Throws:

TodoNotFoundException

InvalidTodoStatusException - if the todo is not alive

setCompressedTodoSavedState

void setCompressedTodoSavedState(long todoId,
                                 CompressedData data)
                          throws TodoNotFoundException,
                                 InvalidTodoStatusException

Sets the todo saved state.

Parameters:

todoId -

data -

Throws:

TodoNotFoundException

InvalidTodoStatusException - if the todo is not alive