Package org.springframework.social.google.api.tasks.impl

Class TaskTemplate

java.lang.Object

org.springframework.social.google.api.impl.AbstractGoogleApiOperations

org.springframework.social.google.api.tasks.impl.TaskTemplate

All Implemented Interfaces:

TaskOperations

public class TaskTemplate
extends AbstractGoogleApiOperations
implements TaskOperations

TaskOperations implementation.

Author:

Gabriel Axel

Field Summary

Fields inherited from class org.springframework.social.google.api.impl.AbstractGoogleApiOperations

isAuthorized, restTemplate

Constructor Summary

Constructors

Constructor	Description
TaskTemplate(org.springframework.web.client.RestTemplate restTemplate, boolean isAuthorized)

Method Summary

Modifier and Type	Method	Description
void	clearCompletedTasks(TaskList taskList)	Hides completed tasks from a task list.
Task	createTaskAt(String taskListId, String parent, String previous, Task task)	Creates a task at a specified position in a task list.
void	deleteTask(String taskId)	Deletes a task from the default task list.
void	deleteTask(String taskListId, String taskId)	Deletes a task from a task list.
void	deleteTask(String taskListId, Task task)	Deletes a task from a task list.
void	deleteTask(Task task)	Deletes a task from the default task list.
void	deleteTaskList(String taskListId)	Deletes a task list.
void	deleteTaskList(TaskList taskList)	Deletes a task list.
Task	getTask(String id)	Retrieves a task from the default task list by its ID.
Task	getTask(String taskListId, String id)	Retrieves a task by its containing task list ID and by the task ID.
TaskList	getTaskList(String id)	Retrieves a task list by its ID.
TaskListsPage	getTaskLists()	Retrieves up to 100 task lists.
TaskListsPage	getTaskLists(String pageToken)	Retrieves task lists page
TasksPage	getTasks()	Retrieves up to 100 active tasks from the default task list.
TasksPage	getTasks(String taskListId, String pageToken)	Retrieved tasks from a task list
Task	moveTask(String taskListId, Task task, String parent, String previous)	Moves a task to a new position in the task list.
Task	saveTask(String taskListId, Task task)	Creates or updates a task in a specified task list.
Task	saveTask(Task task)	Creates or updates a task in the default task list.
TaskList	saveTaskList(TaskList taskList)	Creates or updates a task list.
TaskListQueryBuilder	taskListQuery()	Creates a TaskListQueryBuilder.
TaskQueryBuilder	taskQuery()	Creates a TaskQueryBuilder.

Methods inherited from class org.springframework.social.google.api.impl.AbstractGoogleApiOperations

deleteEntity, deleteEntity, getEntity, patch, requireAuthorization, saveEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskTemplate

public TaskTemplate(org.springframework.web.client.RestTemplate restTemplate,
                    boolean isAuthorized)

Method Detail

getTaskLists

public TaskListsPage getTaskLists()

Description copied from interface: TaskOperations

Retrieves up to 100 task lists.

Specified by:

getTaskLists in interface TaskOperations

Returns:

TaskListsPage with up to 100 items

getTaskLists

public TaskListsPage getTaskLists(String pageToken)

Description copied from interface: TaskOperations

Retrieves task lists page

Specified by:

getTaskLists in interface TaskOperations

Parameters:

pageToken - page token or null

Returns:

TaskLists page

getTaskList

public TaskList getTaskList(String id)

Description copied from interface: TaskOperations

Retrieves a task list by its ID.

Specified by:

getTaskList in interface TaskOperations

Parameters:

id - the task list ID or "@default"

Returns:

the retrieved TaskList

saveTaskList

public TaskList saveTaskList(TaskList taskList)

Description copied from interface: TaskOperations

Creates or updates a task list.

Specified by:

saveTaskList in interface TaskOperations

Parameters:

taskList - the task list to create or update

Returns:

the saved TaskList

deleteTaskList

public void deleteTaskList(TaskList taskList)

Description copied from interface: TaskOperations

Deletes a task list.

Specified by:

deleteTaskList in interface TaskOperations

Parameters:

taskList - the task list to delete

deleteTaskList

public void deleteTaskList(String taskListId)

Description copied from interface: TaskOperations

Deletes a task list.

Specified by:

deleteTaskList in interface TaskOperations

Parameters:

taskListId - the ID of the task list to delete

taskListQuery

public TaskListQueryBuilder taskListQuery()

Description copied from interface: TaskOperations

Creates a TaskListQueryBuilder.

Specified by:

taskListQuery in interface TaskOperations

Returns:

a new TaskListQueryBuilder

getTasks

public TasksPage getTasks()

Description copied from interface: TaskOperations

Retrieves up to 100 active tasks from the default task list.

Specified by:

getTasks in interface TaskOperations

Returns:

TasksPage with up to 100 items

getTasks

public TasksPage getTasks(String taskListId,
                          String pageToken)

Description copied from interface: TaskOperations

Retrieved tasks from a task list

Specified by:

getTasks in interface TaskOperations

Parameters:

taskListId - ID of the task list

pageToken - page token or null

Returns:

Tasks page

getTask

public Task getTask(String id)

Description copied from interface: TaskOperations

Retrieves a task from the default task list by its ID.

Specified by:

getTask in interface TaskOperations

Parameters:

id - the task ID

Returns:

the retrieved Task

getTask

public Task getTask(String taskListId,
                    String id)

Description copied from interface: TaskOperations

Retrieves a task by its containing task list ID and by the task ID.

Specified by:

getTask in interface TaskOperations

Parameters:

taskListId - the containing task list ID

id - the task ID

Returns:

the retrieved Task

saveTask

public Task saveTask(Task task)

Description copied from interface: TaskOperations

Creates or updates a task in the default task list.

Specified by:

saveTask in interface TaskOperations

Parameters:

task - the task to create or update

Returns:

the saved Task

saveTask

public Task saveTask(String taskListId,
                     Task task)

Description copied from interface: TaskOperations

Creates or updates a task in a specified task list.

Specified by:

saveTask in interface TaskOperations

Parameters:

taskListId - the containing task list ID

task - the task to create or update

Returns:

the saved Task

createTaskAt

public Task createTaskAt(String taskListId,
                         String parent,
                         String previous,
                         Task task)

Description copied from interface: TaskOperations

Creates a task at a specified position in a task list.

Specified by:

createTaskAt in interface TaskOperations

Parameters:

taskListId - the containing task list

parent - task ID to become parent of the new task

previous - the task ID after which the new task will be appended

task - the task to create

Returns:

the created Task

moveTask

public Task moveTask(String taskListId,
                     Task task,
                     String parent,
                     String previous)

Description copied from interface: TaskOperations

Moves a task to a new position in the task list.

Specified by:

moveTask in interface TaskOperations

Parameters:

taskListId - the containing task list ID

task - the task to move

parent - the task ID to become parent of the moved task

previous - the task ID after which the moved task will be appended

Returns:

the moved Task

deleteTask

public void deleteTask(String taskId)

Description copied from interface: TaskOperations

Deletes a task from the default task list. Deleted tasks can be retrieved using TaskQueryBuilder.includeDeleted(boolean).

Specified by:

deleteTask in interface TaskOperations

Parameters:

taskId - the ID of the task to delete

deleteTask

public void deleteTask(Task task)

Description copied from interface: TaskOperations

Deletes a task from the default task list. Deleted tasks can be retrieved using TaskQueryBuilder.includeDeleted(boolean).

Specified by:

deleteTask in interface TaskOperations

Parameters:

task - the task to delete

deleteTask

public void deleteTask(String taskListId,
                       String taskId)

Description copied from interface: TaskOperations

Deletes a task from a task list. Deleted tasks can be retrieved using TaskQueryBuilder.includeDeleted(boolean).

Specified by:

deleteTask in interface TaskOperations

Parameters:

taskListId - the containing task list ID

taskId - the ID of the task to delete

deleteTask

public void deleteTask(String taskListId,
                       Task task)

Description copied from interface: TaskOperations

Deletes a task from a task list. Deleted tasks can be retrieved using TaskQueryBuilder.includeDeleted(boolean).

Specified by:

deleteTask in interface TaskOperations

Parameters:

taskListId - the containing task list ID

task - the task to delete

taskQuery

public TaskQueryBuilder taskQuery()

Description copied from interface: TaskOperations

Creates a TaskQueryBuilder.

Specified by:

taskQuery in interface TaskOperations

Returns:

a new TaskQueryBuilder

clearCompletedTasks

public void clearCompletedTasks(TaskList taskList)

Description copied from interface: TaskOperations

Hides completed tasks from a task list. Hidden tasks can be retrieved using TaskQueryBuilder.includeHidden(boolean).

Specified by:

clearCompletedTasks in interface TaskOperations

Parameters:

taskList - the task list to clear