Package ch.aaap.harvestclient.impl

Class UserAssignmentsApiImpl

Object

ch.aaap.harvestclient.impl.UserAssignmentsApiImpl

All Implemented Interfaces:

Api.GetNested<Project,UserAssignment>, UserAssignmentsApi

public class UserAssignmentsApiImpl
extends Object
implements UserAssignmentsApi

Constructor Summary

Constructors

Constructor	Description
UserAssignmentsApiImpl(UserAssignmentService service)

Method Summary

Modifier and Type	Method	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.

Methods inherited from class java.lang.Object

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

Constructor Details

UserAssignmentsApiImpl

public UserAssignmentsApiImpl(UserAssignmentService service)

Method Details

list

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

Specified by:

list in interface UserAssignmentsApi

Parameters:

projectReference - the project containing the assignments

filter - filtering options

Returns:

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

list

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

Specified by:

list in interface UserAssignmentsApi

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 UserAssignments in the project, sorted by creation date, newest first.

get

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

Description copied from interface: UserAssignmentsApi

Return an existing UserAssignment.

Specified by:

get in interface Api.GetNested<Project,UserAssignment>

Specified by:

get in interface UserAssignmentsApi

Parameters:

projectReference - the project containing the assignment

userAssignmentReference - a reference to an existing UserAssignment

Returns:

the full UserAssignment object

create

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

Description copied from interface: UserAssignmentsApi

Create a new UserAssignment

Specified by:

create in interface UserAssignmentsApi

Parameters:

projectReference - the project that will contain the assignment

creationInfo - creation information

Returns:

the created User

update

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

Description copied from interface: UserAssignmentsApi

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

Specified by:

update in interface UserAssignmentsApi

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

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

Description copied from interface: UserAssignmentsApi

Delete an existing UserAssignment.

Specified by:

delete in interface UserAssignmentsApi

Parameters:

projectReference - the project that contains the assignment

userAssignmentReference - An existing UserAssignment to be deleted