com.whitestein.lsps.human.dao

Interface TodoDao

All Superinterfaces:

com.whitestein.lsps.common.BasicDao<Todo,Long>, com.whitestein.lsps.common.BasicReadDao<Todo,Long>

All Known Implementing Classes:

JpaTodoDao

public interface TodoDao
extends com.whitestein.lsps.common.BasicDao<Todo,Long>

Data access object for storing and retrieving Todo.

Author:

mhi

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME DAO name for lookup

Method Summary

Modifier and Type	Method and Description
void	add(Todo todo) Adds todo to the persistent store.
void	add(TodoEscalation todoEscalation) Adds todo escalation to the persistent store.
Long	countLockedTodos(Person person, TodoListCriteria criteria) Returns number of todos locked by user
Long	countTodos(Person person, TodoListCriteria criteria, boolean unlockedOnly) Returns number of todos visible to user, but not locked by user (if unlockedOnly is true).
Collection<String>	findAllOnBehalfOf(Todo todo, Person person) Returns the set ids of users on behalf of which the given person sees the to-do in his to-do list.
QueryResult<Todo>	findByCriteria(TodoCriteria criteria) Returns todos which fulfill the given criteria.
Long	findTodoIdByTask(long modelInstanceId, long taskId) Finds todo id associated with a task.
QueryResult<Todo>	getPersonalTodoList(Person person, PagingCriteria criteria) Returns person's personal todo list (all todos currently locked by given person), according to given paging criteria, sorted by todo priority and issued date.
Map<TodoStatus,Long>	getStatusCounts() Returns a map of to-do counts grouped by the status.
Todo	getTodo(long todoId) Returns the todo identified by the given todoId argument.
Todo	getTodoAndLock(long todoId) Returns the todo identified by the given todoId argument and locks it.
QueryResult<Todo>	getTodoList(Person person, TodoListCriteria criteria) Returns person's todo list, according to given paging criteria.
List<Todo>	getTodoListForOrphanedCheck(Person person, Set<RoleUnitName> removedRoles) Returns list of todos for which a value "isOrphaned" must be recalculated.
long[]	getTodoListIds(Person person, TodoListCriteria criteria) Returns person's todo list ids, according to given paging criteria.
boolean	isUserRejected(long todoId, String personId) Returns true if a todo is rejected by a user.
void	remove(TodoPerformer performer) Removes todo performer.
void	remove(TodoRejection todoRejection) Removes todo-rejection from the persistent store.
void	updateTodoAllocatedTo(Todo todo, Person allocatedTo) Updates todo's allocated-to field according to given allocatedTo person parameter.

Methods inherited from interface com.whitestein.lsps.common.BasicDao

clear, contains, findById, flush, getReferenceById, merge, persist, refresh, refresh, remove

Methods inherited from interface com.whitestein.lsps.common.BasicReadDao

findById, findByIds

Field Detail

NAME

static final String NAME

DAO name for lookup

See Also:

Constant Field Values

Method Detail

add

void add(Todo todo)

Adds todo to the persistent store.

Parameters:

todo - todo

add

void add(TodoEscalation todoEscalation)

Adds todo escalation to the persistent store.

Parameters:

todoEscalation -

remove

void remove(TodoRejection todoRejection)

Removes todo-rejection from the persistent store.

Parameters:

todoRejection -

remove

void remove(TodoPerformer performer)

Removes todo performer.

Parameters:

performer -

findByCriteria

QueryResult<Todo> findByCriteria(TodoCriteria criteria)

Returns todos which fulfill the given criteria.

Parameters:

criteria - criteria for searching

Returns:

query result

getTodo

Todo getTodo(long todoId)

Returns the todo identified by the given todoId argument.

Parameters:

todoId - todo id

Returns:

todo

getTodoAndLock

Todo getTodoAndLock(long todoId)

Returns the todo identified by the given todoId argument and locks it.

Parameters:

todoId - todo id

Returns:

todo locked in the database

findAllOnBehalfOf

Collection<String> findAllOnBehalfOf(Todo todo,
                                     Person person)

Returns the set ids of users on behalf of which the given person sees the to-do in his to-do list.

Parameters:

todo -

person -

Returns:

set of ids

getStatusCounts

Map<TodoStatus,Long> getStatusCounts()

Returns a map of to-do counts grouped by the status.

Returns:

a map of to-do counts grouped by the status

updateTodoAllocatedTo

void updateTodoAllocatedTo(Todo todo,
                           Person allocatedTo)

Updates todo's allocated-to field according to given allocatedTo person parameter.

Parameters:

todo -

allocatedTo -

getPersonalTodoList

QueryResult<Todo> getPersonalTodoList(Person person,
                                      PagingCriteria criteria)

Returns person's personal todo list (all todos currently locked by given person), according to given paging criteria, sorted by todo priority and issued date.

Parameters:

person - the person entity

criteria - the paging criteria

Returns:

QueryResult containing part of result data corresponding to the paging criteria and the total count of todos in the result list

getTodoListIds

long[] getTodoListIds(Person person,
                      TodoListCriteria criteria)

Returns person's todo list ids, according to given paging criteria.

Parameters:

person - the person entity

criteria - the paging criteria

Returns:

array of todo ids corresponding to the paging criteria

getTodoList

QueryResult<Todo> getTodoList(Person person,
                              TodoListCriteria criteria)

Returns person's todo list, according to given paging criteria.

Parameters:

person - the person entity

criteria - the paging criteria

Returns:

QueryResult containing part of result data corresponding to the paging criteria and the total count of todos in the result list

getTodoListForOrphanedCheck

List<Todo> getTodoListForOrphanedCheck(Person person,
                                       Set<RoleUnitName> removedRoles)

Returns list of todos for which a value "isOrphaned" must be recalculated.

Parameters:

person -

removedRoles -

Returns:

the result list

countTodos

Long countTodos(Person person,
                TodoListCriteria criteria,
                boolean unlockedOnly)

Returns number of todos visible to user, but not locked by user (if unlockedOnly is true). In other words returns getTodoList(Person, TodoListCriteria).total - getPersonalTodoList(Person, PagingCriteria).total. If unlocked only is false, returns getTodoList(Person, TodoListCriteria).total

Parameters:

person -

criteria -

unlockedOnly - if true only unlocked todos will be counted

Returns:

number of todos visible to given person

countLockedTodos

Long countLockedTodos(Person person,
                      TodoListCriteria criteria)

Returns number of todos locked by user

Parameters:

person -

criteria -

Returns:

number of todos visible to given person

findTodoIdByTask

Long findTodoIdByTask(long modelInstanceId,
                      long taskId)

Finds todo id associated with a task.

Parameters:

modelInstanceId -

taskId -

Returns:

todo id

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