Package ch.aaap.harvestclient.api

Interface TaskAssignmentsApi

All Superinterfaces:
Api.GetNested<Project,TaskAssignment>
All Known Implementing Classes:
TaskAssignmentsApiImpl
public interface TaskAssignmentsApi extends Api.GetNested<Project,TaskAssignment>
API for TaskAssignments. All methods are specific to a given project
See Also:

  • Method Details

    • list

      List<TaskAssignment> list(Reference<Project> projectReference, TaskAssignmentFilter filter)
      Parameters:
      filter - filtering options
      projectReference - the project containing the assignments
      Returns:
      a list of all TaskAssignments in the project, sorted by creation date, newest first.

    • list

      Pagination<TaskAssignment> list(Reference<Project> projectReference, TaskAssignmentFilter 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 TaskAssignments in the project, sorted by creation date, newest first.

    • get

      TaskAssignment get(Reference<Project> projectReference, Reference<TaskAssignment> taskAssignmentReference)
      Return an existing TaskAssignment.
      Specified by:
      get in interface Api.GetNested<Project,TaskAssignment>
      Parameters:
      projectReference - the project containing the assignment
      taskAssignmentReference - a reference to an existing TaskAssignment
      Returns:
      the full TaskAssignment object

    • create

      TaskAssignment create(Reference<Project> projectReference, TaskAssignment creationInfo)
      Create a new TaskAssignment
      Parameters:
      projectReference - the project that will contain the assignment
      creationInfo - creation information
      Returns:
      the created Task

    • update

      TaskAssignment update(Reference<Project> projectReference, Reference<TaskAssignment> taskAssignmentReference, TaskAssignmentUpdateInfo updateInfo)
      Updates the specific TaskAssignment by setting the values of the parameters passed. Any parameters not provided will be left unchanged
      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

      void delete(Reference<Project> projectReference, Reference<TaskAssignment> taskAssignmentReference)
      Delete an existing TaskAssignment.
      Parameters:
      projectReference - the project that contains the assignment
      taskAssignmentReference - An existing TaskAssignment to be deleted