Package ch.aaap.harvestclient.impl

Class TaskAssignmentsApiImpl

Object

ch.aaap.harvestclient.impl.TaskAssignmentsApiImpl

All Implemented Interfaces:

Api.GetNested<Project,TaskAssignment>, TaskAssignmentsApi

public class TaskAssignmentsApiImpl
extends Object
implements TaskAssignmentsApi

Constructor Summary

Constructors

Constructor	Description
TaskAssignmentsApiImpl(TaskAssignmentService service)

Method Summary

Modifier and Type	Method	Description
TaskAssignment	create(Reference<Project> projectReference, TaskAssignment creationInfo)	Create a new TaskAssignment
void	delete(Reference<Project> projectReference, Reference<TaskAssignment> taskAssignmentReference)	Delete an existing TaskAssignment.
TaskAssignment	get(Reference<Project> projectReference, Reference<TaskAssignment> taskAssignmentReference)	Return an existing TaskAssignment.
List<TaskAssignment>	list(Reference<Project> projectReference, TaskAssignmentFilter filter)
Pagination<TaskAssignment>	list(Reference<Project> projectReference, TaskAssignmentFilter filter, int page, int perPage)
TaskAssignment	update(Reference<Project> projectReference, Reference<TaskAssignment> taskAssignmentReference, TaskAssignmentUpdateInfo updateInfo)	Updates the specific TaskAssignment by setting the values of the parameters passed.

Methods inherited from class java.lang.Object

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

Constructor Details

TaskAssignmentsApiImpl

public TaskAssignmentsApiImpl(TaskAssignmentService service)

Method Details

list

public List<TaskAssignment> list(Reference<Project> projectReference,
 TaskAssignmentFilter filter)

Specified by:

list in interface TaskAssignmentsApi

Parameters:

projectReference - the project containing the assignments

filter - filtering options

Returns:

a list of all TaskAssignments in the project, sorted by creation date, newest first.

list

public Pagination<TaskAssignment> list(Reference<Project> projectReference,
 TaskAssignmentFilter filter,
 int page,
 int perPage)

Specified by:

list in interface TaskAssignmentsApi

Parameters:

projectReference - the project containing the assignments

filter - filtering options

page - the page number

perPage - how many results to return for one page. Max 100

Returns:

a list of all TaskAssignments in the project, sorted by creation date, newest first.

get

public TaskAssignment get(Reference<Project> projectReference,
 Reference<TaskAssignment> taskAssignmentReference)

Description copied from interface: TaskAssignmentsApi

Return an existing TaskAssignment.

Specified by:

get in interface Api.GetNested<Project,TaskAssignment>

Specified by:

get in interface TaskAssignmentsApi

Parameters:

projectReference - the project containing the assignment

taskAssignmentReference - a reference to an existing TaskAssignment

Returns:

the full TaskAssignment object

create

public TaskAssignment create(Reference<Project> projectReference,
 TaskAssignment creationInfo)

Description copied from interface: TaskAssignmentsApi

Create a new TaskAssignment

Specified by:

create in interface TaskAssignmentsApi

Parameters:

projectReference - the project that will contain the assignment

creationInfo - creation information

Returns:

the created Task

update

public TaskAssignment update(Reference<Project> projectReference,
 Reference<TaskAssignment> taskAssignmentReference,
 TaskAssignmentUpdateInfo updateInfo)

Description copied from interface: TaskAssignmentsApi

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

Specified by:

update in interface TaskAssignmentsApi

Parameters:

projectReference - the project that contains the assignment

taskAssignmentReference - An existing TaskAssignment to be updated

updateInfo - the changes to be performed

Returns:

the updated TaskAssignment

delete

public void delete(Reference<Project> projectReference,
 Reference<TaskAssignment> taskAssignmentReference)

Description copied from interface: TaskAssignmentsApi

Delete an existing TaskAssignment.

Specified by:

delete in interface TaskAssignmentsApi

Parameters:

projectReference - the project that contains the assignment

taskAssignmentReference - An existing TaskAssignment to be deleted