ch.aaap.harvestclient.api

Interface TasksApi

All Known Implementing Classes:

TasksApiImpl

public interface TasksApi

Method Summary

Modifier and Type	Method and Description
Task	create(TaskCreationInfo creationInfo) Create a new Task
void	delete(Reference<Task> taskReference) Delete an existing Task.
Task	get(Reference<Task> taskReference) Return an existing Task.
List<Task>	list(TaskFilter filter)
Task	update(Reference<Task> taskReference, TaskUpdateInfo toChange) Updates the specific task by setting the values of the parameters passed.

Method Detail

list

List<Task> list(TaskFilter filter)

Parameters:

filter - filtering options

Returns:

a list of all Tasks in the account, sorted by creation date, newest first.

get

Task get(Reference<Task> taskReference)

Return an existing Task.

Parameters:

taskReference - a reference to an existing Task

Returns:

the full Task object

create

Task create(TaskCreationInfo creationInfo)

Create a new Task

Parameters:

creationInfo - creation information

Returns:

the created Task

update

Task update(Reference<Task> taskReference,
            TaskUpdateInfo toChange)

Updates the specific task by setting the values of the parameters passed. Any parameters not provided will be left unchanged

Parameters:

taskReference - An existing Task to be updated

toChange - the changes to be performed

Returns:

the updated Task

delete

void delete(Reference<Task> taskReference)

Delete an existing Task. Only possible if no time entries are associated with it

Parameters:

taskReference - a reference to the Task to be deleted