ch.aaap.harvestclient.api

Interface UserAssignmentsApi

All Superinterfaces:

Api.GetNested<Project,UserAssignment>

All Known Implementing Classes:

UserAssignmentsApiImpl

public interface UserAssignmentsApi
extends Api.GetNested<Project,UserAssignment>

API for UserAssignments. All methods are specific to a given project

See Also:

Project User Assignments API on Harvest

Method Summary

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

Method Detail

list

List<UserAssignment> list(Reference<Project> projectReference,
                          UserAssignmentFilter filter)

Parameters:

filter - filtering options

projectReference - the project containing the assignments

Returns:

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

list

Pagination<UserAssignment> list(Reference<Project> projectReference,
                                UserAssignmentFilter filter,
                                int page,
                                int perPage)

Parameters:

filter - filtering options

projectReference - the project containing the assignments

page - the page number

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

Returns:

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

get

UserAssignment get(Reference<Project> projectReference,
                   Reference<UserAssignment> userAssignmentReference)

Return an existing UserAssignment.

Specified by:

get in interface Api.GetNested<Project,UserAssignment>

Parameters:

projectReference - the project containing the assignment

userAssignmentReference - a reference to an existing UserAssignment

Returns:

the full UserAssignment object

create

UserAssignment create(Reference<Project> projectReference,
                      UserAssignment creationInfo)

Create a new UserAssignment

Parameters:

projectReference - the project that will contain the assignment

creationInfo - creation information

Returns:

the created User

update

UserAssignment update(Reference<Project> projectReference,
                      Reference<UserAssignment> userAssignmentReference,
                      UserAssignmentUpdateInfo updateInfo)

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

Parameters:

projectReference - the project that contains the assignment

userAssignmentReference - An existing UserAssignment to be updated

updateInfo - the changes to be performed

Returns:

the updated UserAssignment

delete

void delete(Reference<Project> projectReference,
            Reference<UserAssignment> userAssignmentReference)

Delete an existing UserAssignment.

Parameters:

projectReference - the project that contains the assignment

userAssignmentReference - An existing UserAssignment to be deleted