com.communote.server.persistence.tasks

Interface TaskDao

All Known Implementing Classes:

TaskDaoBase, TaskDaoImpl

public interface TaskDao

Author:

Communote GmbH - http://www.communote.com/

See Also:

Task

Field Summary

Fields

Modifier and Type	Field and Description
static int	TRANSFORM_NONE This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

Method Summary

Modifier and Type	Method and Description
Collection<Task>	create(Collection<Task> entities) Creates a new instance of com.communote.server.persistence.tasks.Task and adds from the passed in entities collection
Collection<?>	create(int transform, Collection<Task> entities) Does the same thing as create(com.communote.server.model.task.Task) with an additional flag called transform.
Object	create(int transform, Task task) Does the same thing as create(com.communote.server.model.task.Task) with an additional flag called transform.
Task	create(Task task) Creates an instance of com.communote.server.persistence.tasks.Task and adds it to the persistent store.
void	evict(Task entity) Evicts (removes) the entity from the hibernate cache
Task	findNextScheduledTask()
Collection<Task>	findNextScheduledTasks(Date upperBound, int maxTasks, Collection<Long> taskIdsToExclude) Returns all task, which can be scheduled within the next time frame.
Task	findTaskByUniqueName(String uniqueName)
Object	load(int transform, Long id) Does the same thing as load(Long) with an additional flag called transform.
Task	load(Long id) Loads an instance of com.communote.server.persistence.tasks.Task from the persistent store.
Collection<Task>	loadAll() Loads all entities of type Task.
Collection<?>	loadAll(int transform) Does the same thing as loadAll() with an additional flag called transform.
void	remove(Collection<Task> entities) Removes all entities in the given entities collection.
void	remove(Long id) Removes the instance of com.communote.server.persistence.tasks.Task having the given identifier from the persistent store.
void	remove(Task task) Removes the instance of com.communote.server.persistence.tasks.Task from the persistent store.
void	update(Collection<Task> entities) Updates all instances in the entities collection in the persistent store.
void	update(Task task) Updates the task instance in the persistent store.

Field Detail

TRANSFORM_NONE

static final int TRANSFORM_NONE

This constant is used as a transformation flag; entities can be converted automatically into value objects or other types, different methods in a class implementing this interface support this feature: look for an int parameter called transform.

This specific flag denotes no transformation will occur.

See Also:

Constant Field Values

Method Detail

create

Task create(Task task)

Creates an instance of com.communote.server.persistence.tasks.Task and adds it to the persistent store.

create

Object create(int transform,
              Task task)

Does the same thing as create(com.communote.server.model.task.Task) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

create

Collection<?> create(int transform,
                     Collection<Task> entities)

Does the same thing as create(com.communote.server.model.task.Task) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entities (into value objects for example). By default, transformation does not occur.

create

Collection<Task> create(Collection<Task> entities)

Creates a new instance of com.communote.server.persistence.tasks.Task and adds from the passed in entities collection

Parameters:

entities - the collection of com.communote.server.persistence.tasks.Task instances to create.

Returns:

the created instances.

evict

void evict(Task entity)

Evicts (removes) the entity from the hibernate cache

Parameters:

entity - the entity to evict

findNextScheduledTask

Task findNextScheduledTask()

Returns:

Returns the next task to schedule or null if there is none.

findNextScheduledTasks

Collection<Task> findNextScheduledTasks(Date upperBound,
                                        int maxTasks,
                                        Collection<Long> taskIdsToExclude)

Returns all task, which can be scheduled within the next time frame.

findTaskByUniqueName

Task findTaskByUniqueName(String uniqueName)

Returns:

The task specified by its name or null.

load

Object load(int transform,
            Long id)

Does the same thing as load(Long) with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined in this class then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Parameters:

id - the identifier of the entity to load.

Returns:

either the entity or the object transformed from the entity.

load

Task load(Long id)

Loads an instance of com.communote.server.persistence.tasks.Task from the persistent store.

loadAll

Collection<Task> loadAll()

Loads all entities of type Task.

Returns:

the loaded entities.

loadAll

Collection<?> loadAll(int transform)

Does the same thing as loadAll() with an additional flag called transform. If this flag is set to TRANSFORM_NONE then the returned entity will NOT be transformed. If this flag is any of the other constants defined here then the result WILL BE passed through an operation which can optionally transform the entity (into a value object for example). By default, transformation does not occur.

Parameters:

transform - the flag indicating what transformation to use.

Returns:

the loaded entities.

remove

void remove(Task task)

Removes the instance of com.communote.server.persistence.tasks.Task from the persistent store.

remove

void remove(Collection<Task> entities)

Removes all entities in the given entities collection.

remove

void remove(Long id)

Removes the instance of com.communote.server.persistence.tasks.Task having the given identifier from the persistent store.

update

void update(Task task)

Updates the task instance in the persistent store.

update

void update(Collection<Task> entities)

Updates all instances in the entities collection in the persistent store.