com.mambu.apisdk.services

Class TasksService

java.lang.Object

com.mambu.apisdk.services.TasksService

public class TasksService
extends java.lang.Object

Service class which handles API operations like getting and creating tasks

Constructor Summary

Constructors

Constructor and Description
TasksService(MambuAPIService mambuAPIService) Create a new task service

Method Summary

Modifier and Type	Method and Description
com.mambu.tasks.shared.model.Task	createTask(java.lang.String title, java.lang.String username, java.lang.String description, java.util.Date dueDate, java.lang.String clientId, java.lang.String groupId) Creates a new task using an html form encoded request
com.mambu.tasks.shared.model.Task	createTask(com.mambu.tasks.shared.model.Task task) Create a new task using a Task object in a json request
boolean	deleteTask(java.lang.String taskId) Delete task by its Id
java.util.List<com.mambu.tasks.shared.model.Task>	getClientTasks(java.lang.String clientId, com.mambu.tasks.shared.model.TaskStatus taskStatus, java.lang.String offset, java.lang.String limit) Convenience method to Get tasks for a client
java.util.List<com.mambu.tasks.shared.model.Task>	getGroupTasks(java.lang.String groupId, com.mambu.tasks.shared.model.TaskStatus taskStatus, java.lang.String offset, java.lang.String limit) Convenience method to Get tasks for a group
java.util.List<com.mambu.tasks.shared.model.Task>	getTasks(java.lang.String username, java.lang.String clientId, java.lang.String groupId, com.mambu.tasks.shared.model.TaskStatus taskStatus, java.lang.String offset, java.lang.String limit) Get tasks based on the specified criteria, which can include clientId, username, and/or task's state
com.mambu.tasks.shared.model.Task	updateTask(com.mambu.tasks.shared.model.Task task) Update an existent task using a Task object in a json request

Methods inherited from class java.lang.Object

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

Constructor Detail

TasksService

@Inject
public TasksService(MambuAPIService mambuAPIService)

Create a new task service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

createTask

public com.mambu.tasks.shared.model.Task createTask(com.mambu.tasks.shared.model.Task task)
                                             throws MambuApiException

Create a new task using a Task object in a json request

Parameters:

task - the new task object containing all mandatory fields. The encoded key must be null for new tasks

Returns:

the new task parsed as an object returned from the API call

Throws:

MambuApiException

updateTask

public com.mambu.tasks.shared.model.Task updateTask(com.mambu.tasks.shared.model.Task task)
                                             throws MambuApiException

Update an existent task using a Task object in a json request

Parameters:

task - the existent task object containing all mandatory fields. The encoded key must not be null for updating tasks

Returns:

the updated task parsed as an object returned from the API call

Throws:

MambuApiException

createTask

public com.mambu.tasks.shared.model.Task createTask(java.lang.String title,
                                                    java.lang.String username,
                                                    java.lang.String description,
                                                    java.util.Date dueDate,
                                                    java.lang.String clientId,
                                                    java.lang.String groupId)
                                             throws MambuApiException

Creates a new task using an html form encoded request

Parameters:

title - title (mandatory)

username - username, encodedKey or user id

description - description

dueDate - due date

clientId - client encoded key or id

groupId - group encoded key or id

Returns:

the new task parsed as an object returned from the API call

Throws:

MambuApiException

getTasks

public java.util.List<com.mambu.tasks.shared.model.Task> getTasks(java.lang.String username,
                                                                  java.lang.String clientId,
                                                                  java.lang.String groupId,
                                                                  com.mambu.tasks.shared.model.TaskStatus taskStatus,
                                                                  java.lang.String offset,
                                                                  java.lang.String limit)
                                                           throws MambuApiException

Get tasks based on the specified criteria, which can include clientId, username, and/or task's state

Parameters:

username - username, encodedKey or user id. If usename is not null then all tasks for this user are returned

clientId - client encodedKey or id. To get tasks for the client the clientId must not be null and the groupId and username must be null.

groupId - group encodedKey or id. To get tasks for the group the groupId must not be null and the clientId and username must be null.

taskStatus - task status

offset - pagination offset

limit - pagination limit

Returns:

a list of tasks matching specified criteria. If tasksStatus is null then Open tasks are returned. To get tasks for the user a username(or id) must not be null. To get tasks for the client the clientId must not be null and the username must be null. If both username and clientId are not null then the clientId is ignored and all tasks for the user are returned.

Throws:

MambuApiException

getClientTasks

public java.util.List<com.mambu.tasks.shared.model.Task> getClientTasks(java.lang.String clientId,
                                                                        com.mambu.tasks.shared.model.TaskStatus taskStatus,
                                                                        java.lang.String offset,
                                                                        java.lang.String limit)
                                                                 throws MambuApiException

Convenience method to Get tasks for a client

Parameters:

clientId - client encodedKey or id

taskStatus - task status

offset - pagination offset

limit - pagination limit

Returns:

a list of tasks for the client

Throws:

MambuApiException

getGroupTasks

public java.util.List<com.mambu.tasks.shared.model.Task> getGroupTasks(java.lang.String groupId,
                                                                       com.mambu.tasks.shared.model.TaskStatus taskStatus,
                                                                       java.lang.String offset,
                                                                       java.lang.String limit)
                                                                throws MambuApiException

Convenience method to Get tasks for a group

Parameters:

groupId - group encodedKey or id

taskStatus - task status

offset - pagination offset

limit - pagination limit

Returns:

a list of tasks for the group

Throws:

MambuApiException

deleteTask

public boolean deleteTask(java.lang.String taskId)
                   throws MambuApiException

Delete task by its Id

Parameters:

taskId -

Returns:

status

Throws:

MambuApiException