io.taskmonk.client

Class TaskMonkClient

java.lang.Object

io.taskmonk.client.TaskMonkClient

public class TaskMonkClient
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TaskMonkClient(java.lang.String projectId, java.lang.String server, OAuthClientCredentials credentials)
TaskMonkClient(java.lang.String projectId, java.lang.String server, java.lang.String proxy, OAuthClientCredentials credentials)

Method Summary

Modifier and Type	Method and Description
java.lang.String	addTask(java.lang.String batchId, Task task) Add an external task
java.lang.String	createBatch(NewBatchData newBatchData) Create a new batch in an existing project with parameters set
java.lang.String	createBatch(java.lang.String batchName) Create a new batch in an existing project
java.lang.Boolean	deleteBatch(java.lang.String batchId) To delete a specific batch
ApiResponse	editBatch(java.lang.String batchId, java.lang.String batchName, java.lang.Integer priority, java.lang.String comments, java.util.List<Notification> notifications) update the details of an existing batch
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	getBatchOutput(java.lang.String projectId, java.lang.String batchId) Get the batch output as a dictionary .
void	getBatchOutput(java.lang.String batchId, java.lang.String outputFormat, java.lang.String outputPath) Get the batch output in a local file path
BatchStatus	getBatchStatus(java.lang.String batchId) Get the status of the batch
JobProgressResponse	getJobProgress(java.lang.String jobId) Get the progress of a job
JobProgressResponse	getJobProgressBatch(java.lang.String batchId) Get the progress of batch
java.lang.Boolean	isProcessComplete(java.lang.String batchId) To check if a process is complete
java.lang.Boolean	isUploadComplete(java.lang.String batchId) To check if the upload is complete or not
ApiResponse	updateBatchState(java.lang.String batchId, BatchState state) update the state for a batch
TaskImportResponse	uploadTasks(java.lang.String batchName, java.io.File file) Create a new batch in an existing project and add tasks to it
java.lang.String	uploadTasks(java.lang.String projectId, java.lang.String batchId, java.util.List<java.util.Map<java.lang.String,java.lang.String>> inputValues) Add tasks to TaskMonk
TaskImportResponse	uploadTasksToBatch(java.lang.String batchId, java.io.File file) Add tasks to an existing batch
TaskImportResponse	uploadTasksUrl(java.lang.String batchName, java.lang.String taskUrl, java.lang.String fileType) Create a new batch in an existing project and add tasks to it from an accessible url
TaskImportResponse	uploadTasksUrlToBatch(java.lang.String batchId, java.lang.String taskUrl, java.lang.String fileType) Add tasks to an existing batch from an accessible url

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskMonkClient

public TaskMonkClient(java.lang.String projectId,
                      java.lang.String server,
                      OAuthClientCredentials credentials)

TaskMonkClient

public TaskMonkClient(java.lang.String projectId,
                      java.lang.String server,
                      java.lang.String proxy,
                      OAuthClientCredentials credentials)

Method Detail

createBatch

public java.lang.String createBatch(NewBatchData newBatchData)
                             throws java.lang.Exception

Create a new batch in an existing project with parameters set

Parameters:

newBatchData - NewBatchData New batch information

Returns:

String returns the id of the batch

Throws:

ForbiddenException - if the access is unauthorized

NotFoundException - if object not found

InternalServerError - if an internal server error occurs

UnhandledException - if unhandled exception occurs

java.lang.Exception

createBatch

public java.lang.String createBatch(java.lang.String batchName)
                             throws java.lang.Exception

Create a new batch in an existing project

Parameters:

batchName - . name of the batch to be created

Returns:

String returns the id of the batch

Throws:

ForbiddenException - if the access is unauthorized

NotFoundException - if object not found

InternalServerError - if an internal server error occurs

UnhandledException - if unhandled exception occurs

java.lang.Exception

editBatch

public ApiResponse editBatch(java.lang.String batchId,
                             java.lang.String batchName,
                             java.lang.Integer priority,
                             java.lang.String comments,
                             java.util.List<Notification> notifications)
                      throws java.lang.Exception

update the details of an existing batch

Parameters:

batchId - - id of an existing batch

batchName - - name of new batch

priority - - priority of batch

comments - - comments in new batch

notifications - - notifications of a new batch

Returns:

ApiResponse - returns the id of the updated batch

Throws:

ForbiddenException - if the access is unauthorized

NotFoundException - if object not found

InternalServerError - if an internal server error occurs

UnhandledException - if unhandled exception occurs

java.lang.Exception

updateBatchState

public ApiResponse updateBatchState(java.lang.String batchId,
                                    BatchState state)
                             throws java.lang.Exception

update the state for a batch

Parameters:

batchId - - id of an existing batch

state - - new state for the String. Allowed - CANCELLED

Returns:

ApiResponse - returns the id of the updated batch

Throws:

ForbiddenException - if the access is unauthorized

NotFoundException - if object not found

InternalServerError - if an internal server error occurs

UnhandledException - if unhandled exception occurs

java.lang.Exception

uploadTasks

public TaskImportResponse uploadTasks(java.lang.String batchName,
                                      java.io.File file)
                               throws java.lang.Exception

Create a new batch in an existing project and add tasks to it

Parameters:

batchName - - name of the batch to be created

file - - file of the tasks to be added

Returns:

TaskImportResponse returns the task import response

Throws:

ForbiddenException - if the access is unauthorized

NotFoundException - if object not found

InternalServerError - if an internal server error occurs

UnhandledException - if unhandled exception occurs

java.lang.Exception

uploadTasksUrl

public TaskImportResponse uploadTasksUrl(java.lang.String batchName,
                                         java.lang.String taskUrl,
                                         java.lang.String fileType)
                                  throws java.lang.Exception

Create a new batch in an existing project and add tasks to it from an accessible url

Parameters:

batchName - - name of the batch to be created

taskUrl - - url of the file from which the tasks will be imported

fileType - - type of file from which the tasks would be fetched

Returns:

TaskImportResponse - returns the task import response

Throws:

ForbiddenException - if the access is unauthorized

NotFoundException - if object not found

InternalServerError - if an internal server error occurs

UnhandledException - if unhandled exception occurs

java.lang.Exception

uploadTasksToBatch

public TaskImportResponse uploadTasksToBatch(java.lang.String batchId,
                                             java.io.File file)
                                      throws java.lang.Exception

Add tasks to an existing batch

Parameters:

batchId - - batch id of an existing batch to which the tasks are to be added

file - - file of the tasks to be added

Returns:

TaskImportResponse - returns the task import response

Throws:

ForbiddenException - if the access is unauthorized

NotFoundException - if object not found

InternalServerError - if an internal server error occurs

UnhandledException - if unhandled exception occurs

java.lang.Exception

uploadTasksUrlToBatch

public TaskImportResponse uploadTasksUrlToBatch(java.lang.String batchId,
                                                java.lang.String taskUrl,
                                                java.lang.String fileType)
                                         throws java.lang.Exception

Add tasks to an existing batch from an accessible url

Parameters:

batchId - - batch id of the batch to which the tasks are to be added

taskUrl - - url of the file from which the tasks would be imported

fileType - - type of file from which the tasks would be fetched

Returns:

TaskImportResponse - returns the task import response

Throws:

ForbiddenException - if the access is unauthorized

NotFoundException - if object not found

InternalServerError - if an internal server error occurs

UnhandledException - if unhandled exception occurs

java.lang.Exception

addTask

public java.lang.String addTask(java.lang.String batchId,
                                Task task)
                         throws java.lang.Exception

Add an external task

Parameters:

batchId -

task - Task - the task to be added

Returns:

task id of the newly created task

Throws:

ForbiddenException - if the access is unauthorized

NotFoundException - if object not found

InternalServerError - if an internal server error occurs

UnhandledException - if unhandled exception occurs

java.lang.Exception

uploadTasks

public java.lang.String uploadTasks(java.lang.String projectId,
                                    java.lang.String batchId,
                                    java.util.List<java.util.Map<java.lang.String,java.lang.String>> inputValues)
                             throws java.lang.Exception

Add tasks to TaskMonk

Parameters:

inputValues - - List of tasks to be added. Each task is represented by a map of input field to value

batchId -

projectId -

Returns:

Job Id for the import task

Throws:

java.lang.Exception

getBatchOutput

public void getBatchOutput(java.lang.String batchId,
                           java.lang.String outputFormat,
                           java.lang.String outputPath)
                    throws java.lang.Exception

Get the batch output in a local file path

Parameters:

batchId - - batch id of an existing batch

outputFormat - output format for the file - "CSV" or "Excel"

outputPath - - path where the output file should be created

Throws:

ForbiddenException - if the access is unauthorized

NotFoundException - if object not found

InternalServerError - if an internal server error occurs

UnhandledException - if unhandled exception occurs

java.lang.Exception

getBatchOutput

public java.util.List<java.util.Map<java.lang.String,java.lang.String>> getBatchOutput(java.lang.String projectId,
                                                                                       java.lang.String batchId)
                                                                                throws java.lang.Exception

Get the batch output as a dictionary . The output is an List of tasks. Each task is a Map with the field and its value.

Parameters:

projectId -

batchId -

Returns:

A list of tasks with the field and values

Throws:

java.lang.Exception

getJobProgress

public JobProgressResponse getJobProgress(java.lang.String jobId)
                                   throws java.lang.Exception

Get the progress of a job

Parameters:

jobId - - job id of the job

Returns:

JobProgressResponse - returns the job progress response

Throws:

ForbiddenException - if the access is unauthorized

NotFoundException - if object not found

InternalServerError - if an internal server error occurs

UnhandledException - if unhandled exception occurs

java.lang.Exception

getJobProgressBatch

public JobProgressResponse getJobProgressBatch(java.lang.String batchId)
                                        throws java.lang.Exception

Get the progress of batch

Parameters:

batchId - - id of the batch

Returns:

JobProgressResponse - returns the job progress response

Throws:

ForbiddenException - if the access is unauthorized

NotFoundException - if object not found

InternalServerError - if an internal server error occurs

UnhandledException - if unhandled exception occurs

java.lang.Exception

getBatchStatus

public BatchStatus getBatchStatus(java.lang.String batchId)
                           throws java.lang.Exception

Get the status of the batch

Parameters:

batchId - - id of the batch

Returns:

BatchStatus - returns the batch status

Throws:

ForbiddenException - if the access is unauthorized

NotFoundException - if object not found

InternalServerError - if an internal server error occurs

UnhandledException - if unhandled exception occurs

java.lang.Exception

isProcessComplete

public java.lang.Boolean isProcessComplete(java.lang.String batchId)
                                    throws java.lang.Exception

To check if a process is complete

Parameters:

batchId - - id of the batch

Returns:

Boolean - returns true or false depending on completion of process

Throws:

ForbiddenException - if the access is unauthorized

NotFoundException - if object not found

InternalServerError - if an internal server error occurs

UnhandledException - if unhandled exception occurs

java.lang.Exception

isUploadComplete

public java.lang.Boolean isUploadComplete(java.lang.String batchId)
                                   throws java.lang.Exception

To check if the upload is complete or not

Parameters:

batchId - - id of the batch

Returns:

Boolean - returns true or false depending upon upload status

Throws:

ForbiddenException - if the access is unauthorized

NotFoundException - if object not found

InternalServerError - if an intfieldNamesernal server error occurs

UnhandledException - if unhandled exception occurs

java.lang.Exception

deleteBatch

public java.lang.Boolean deleteBatch(java.lang.String batchId)
                              throws java.lang.Exception

To delete a specific batch

Parameters:

batchId - - id of the batch

Returns:

Boolean - returns the deleted batchId

Throws:

java.lang.Exception