Package ch.aaap.harvestclient.impl

Class ExpenseCategoriesApiImpl

Object

ch.aaap.harvestclient.impl.ExpenseCategoriesApiImpl

All Implemented Interfaces:

Api.Create<ExpenseCategory>, Api.Delete<ExpenseCategory>, Api.Get<ExpenseCategory>, Api.Simple<ExpenseCategory>, ExpenseCategoriesApi

public class ExpenseCategoriesApiImpl
extends Object
implements ExpenseCategoriesApi

Constructor Summary

Constructors

Constructor	Description
ExpenseCategoriesApiImpl(ExpenseCategoryService service)

Method Summary

Modifier and Type	Method	Description
ExpenseCategory	create(ExpenseCategory creationInfo)	Create a new ExpenseCategory.
void	delete(Reference<ExpenseCategory> expenseCategoryReference)	Delete an existing ExpenseCategory.
ExpenseCategory	get(Reference<ExpenseCategory> expenseCategoryReference)	Return an existing ExpenseCategory.
List<ExpenseCategory>	list(ExpenseCategoryFilter filter)
Pagination<ExpenseCategory>	list(ExpenseCategoryFilter filter, int page, int perPage)
ExpenseCategory	update(Reference<ExpenseCategory> expenseCategoryReference, ExpenseCategoryUpdateInfo toChange)	Updates the specific expenseCategories 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

ExpenseCategoriesApiImpl

public ExpenseCategoriesApiImpl(ExpenseCategoryService service)

Method Details

list

public List<ExpenseCategory> list(ExpenseCategoryFilter filter)

Specified by:

list in interface ExpenseCategoriesApi

Parameters:

filter - filtering options

Returns:

a list of all ExpenseCategories in the account, sorted by creation date, newest first.

list

public Pagination<ExpenseCategory> list(ExpenseCategoryFilter filter,
 int page,
 int perPage)

Specified by:

list in interface ExpenseCategoriesApi

Parameters:

filter - filtering options

page - the page number

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

Returns:

a list of all ExpenseCategories in the account, sorted by creation date, newest first.

get

public ExpenseCategory get(Reference<ExpenseCategory> expenseCategoryReference)

Description copied from interface: ExpenseCategoriesApi

Return an existing ExpenseCategory.

Specified by:

get in interface Api.Get<ExpenseCategory>

Specified by:

get in interface ExpenseCategoriesApi

Parameters:

expenseCategoryReference - a reference to an existing ExpenseCategory

Returns:

the full ExpenseCategory object

create

public ExpenseCategory create(ExpenseCategory creationInfo)

Description copied from interface: ExpenseCategoriesApi

Create a new ExpenseCategory. Example:

 ExpenseCategory expenseCategories = harvest.expenseCategories().create(ImmutableExpenseCategory.builder()
         .name("category name")
         .build());
 

Specified by:

create in interface Api.Create<ExpenseCategory>

Specified by:

create in interface ExpenseCategoriesApi

Parameters:

creationInfo - creation information

Returns:

the created ExpenseCategory

update

public ExpenseCategory update(Reference<ExpenseCategory> expenseCategoryReference,
 ExpenseCategoryUpdateInfo toChange)

Description copied from interface: ExpenseCategoriesApi

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

Specified by:

update in interface ExpenseCategoriesApi

Parameters:

expenseCategoryReference - An existing ExpenseCategory to be updated

toChange - the changes to be performed

Returns:

the updated ExpenseCategory

delete

public void delete(Reference<ExpenseCategory> expenseCategoryReference)

Description copied from interface: ExpenseCategoriesApi

Delete an existing ExpenseCategory.

Specified by:

delete in interface Api.Delete<ExpenseCategory>

Specified by:

delete in interface ExpenseCategoriesApi

Parameters:

expenseCategoryReference - a reference to the ExpenseCategory to be deleted