Package ch.aaap.harvestclient.impl

Class ProjectsApiImpl

Object

ch.aaap.harvestclient.impl.ProjectsApiImpl

All Implemented Interfaces:

Api.Create<Project>, Api.Delete<Project>, Api.Get<Project>, Api.Simple<Project>, ProjectsApi

public class ProjectsApiImpl
extends Object
implements ProjectsApi

Constructor Summary

Constructors

Constructor	Description
ProjectsApiImpl(ProjectService service)

Method Summary

Modifier and Type	Method	Description
Project	create(Project 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.
Pagination<Project>	list(ProjectFilter filter, int page, int perPage)	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

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectsApiImpl

public ProjectsApiImpl(ProjectService service)

Method Details

list

public List<Project> list(ProjectFilter filter)

Description copied from interface: ProjectsApi

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

Specified by:

list in interface ProjectsApi

Parameters:

filter - filtering options

Returns:

a (filtered) list of Projects

list

public Pagination<Project> list(ProjectFilter filter,
 int page,
 int perPage)

Description copied from interface: ProjectsApi

Return a list of projects, sorted by creation date, newest first. Use the filter object to filter the list. Page and perPage allow controlling how many results to return.

Specified by:

list in interface ProjectsApi

Parameters:

filter - filtering options

page - the page number

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

Returns:

a (filtered) list of Projects

get

public Project get(Reference<Project> projectReference)

Specified by:

get in interface Api.Get<Project>

Specified by:

get in interface ProjectsApi

Parameters:

projectReference - a reference to an existing Project

Returns:

Return a full Project object

create

public Project create(Project projectCreationInfo)

Description copied from interface: ProjectsApi

Create a new Project according to given creation information. Example:

 Project creationInfo = ImmutableProject.builder()
         .client(clientReference)
         .name(name)
         .billable(billable)
         .billBy(billingMethod)
         .budgetBy(budgetBy)
         .build();
 project = projectsApi.create(creationInfo);
 

Specified by:

create in interface Api.Create<Project>

Specified by:

create in interface ProjectsApi

Parameters:

projectCreationInfo - the creation options

Returns:

the newly created Project

update

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

Description copied from interface: ProjectsApi

Updates an existing Project with the properties set in ProjectUpdateInfo

Specified by:

update in interface ProjectsApi

Parameters:

projectReference - the existing project to be updated

toChange - the properties to be updated

Returns:

the updated Project

delete

public void delete(Reference<Project> projectReference)

Description copied from interface: ProjectsApi

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.

Specified by:

delete in interface Api.Delete<Project>

Specified by:

delete in interface ProjectsApi

Parameters:

projectReference - a reference to an existing Project to be deleted