ch.aaap.harvestclient.api

Interface ProjectsApi

All Known Implementing Classes:

ProjectsApiImpl

public interface ProjectsApi

Method Summary

Modifier and Type	Method and Description
Project	create(ProjectCreationInfo projectCreationInfo) Create a new Project according to given creation information.
void	delete(Reference<Project> projectReference) Delete an existing Project.
Project	get(Reference<Project> projectReference)
List<Project>	list(ProjectFilter filter) Return a list of projects, sorted by creation date, newest first.
Project	update(Reference<Project> projectReference, ProjectUpdateInfo toChange) Updates an existing Project with the properties set in ProjectUpdateInfo

Method Detail

list

List<Project> list(ProjectFilter filter)

Return a list of projects, sorted by creation date, newest first. Use the filter object to filter the list.

Parameters:

filter - filtering options

Returns:

a (filtered) list of Projects

get

Project get(Reference<Project> projectReference)

Parameters:

projectReference - a reference to an existing Project

Returns:

Return a full Project object

create

Project create(ProjectCreationInfo projectCreationInfo)

Create a new Project according to given creation information.

Parameters:

projectCreationInfo - the creation options

Returns:

the newly created Project

update

Project update(Reference<Project> projectReference,
               ProjectUpdateInfo toChange)

Updates an existing Project with the properties set in ProjectUpdateInfo

Parameters:

projectReference - the existing project to be updated

toChange - the properties to be updated

Returns:

the updated Project

delete

void delete(Reference<Project> projectReference)

Delete an existing Project. Careful with this API! It also deletes TimeEntries, Expenses and Retainers connected to this project. This will generate an email notification from Harvest.

Parameters:

projectReference - a reference to an existing Project to be deleted