Package ch.aaap.harvestclient.impl

Class EstimateItemCategoriesApiImpl

Object

ch.aaap.harvestclient.impl.EstimateItemCategoriesApiImpl

All Implemented Interfaces:

Api.Create<EstimateItem.Category>, Api.Delete<EstimateItem.Category>, Api.Get<EstimateItem.Category>, Api.Simple<EstimateItem.Category>, EstimateItemCategoriesApi

public class EstimateItemCategoriesApiImpl
extends Object
implements EstimateItemCategoriesApi

Constructor Summary

Constructors

Constructor	Description
EstimateItemCategoriesApiImpl(EstimateItemCategoryService service)

Method Summary

Modifier and Type	Method	Description
EstimateItem.Category	create(EstimateItem.Category creationInfo)	Create a new EstimateItemCategory
void	delete(Reference<EstimateItem.Category> categoryReference)	Delete an existing EstimateItemCategory.
EstimateItem.Category	get(Reference<EstimateItem.Category> categoryReference)	Return an existing EstimateItemCategory.
List<EstimateItem.Category>	list(Instant updatedSince)
Pagination<EstimateItem.Category>	list(Instant updatedSince, int page, int perPage)	Return a list of estimateItemCategories, sorted by creation date, newest first.
EstimateItem.Category	update(Reference<EstimateItem.Category> categoryReference, EstimateItem.Category toChange)	Updates the specific estimateItemCategory 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

EstimateItemCategoriesApiImpl

public EstimateItemCategoriesApiImpl(EstimateItemCategoryService service)

Method Details

list

public List<EstimateItem.Category> list(@Nullable
 Instant updatedSince)

Specified by:

list in interface EstimateItemCategoriesApi

Parameters:

updatedSince - if set, only return categories updated since the given timestamp

Returns:

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

list

public Pagination<EstimateItem.Category> list(@Nullable
 Instant updatedSince,
 int page,
 int perPage)

Description copied from interface: EstimateItemCategoriesApi

Return a list of estimateItemCategories, 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 EstimateItemCategoriesApi

Parameters:

updatedSince - if set, only return categories updated since the given timestamp

page - the page number

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

Returns:

a (filtered) list of EstimateItemCategory

get

public EstimateItem.Category get(Reference<EstimateItem.Category> categoryReference)

Description copied from interface: EstimateItemCategoriesApi

Return an existing EstimateItemCategory.

Specified by:

get in interface Api.Get<EstimateItem.Category>

Specified by:

get in interface EstimateItemCategoriesApi

Parameters:

categoryReference - a reference to an existing EstimateItemCategory

Returns:

the full EstimateItemCategory object

create

public EstimateItem.Category create(EstimateItem.Category creationInfo)

Description copied from interface: EstimateItemCategoriesApi

Create a new EstimateItemCategory

Specified by:

create in interface Api.Create<EstimateItem.Category>

Specified by:

create in interface EstimateItemCategoriesApi

Parameters:

creationInfo - creation information

Returns:

the created EstimateItemCategory

update

public EstimateItem.Category update(Reference<EstimateItem.Category> categoryReference,
 EstimateItem.Category toChange)

Description copied from interface: EstimateItemCategoriesApi

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

Specified by:

update in interface EstimateItemCategoriesApi

Parameters:

categoryReference - An existing EstimateItemCategory to be updated

toChange - the changes to be performed

Returns:

the updated EstimateItemCategory

delete

public void delete(Reference<EstimateItem.Category> categoryReference)

Description copied from interface: EstimateItemCategoriesApi

Delete an existing EstimateItemCategory.

Specified by:

delete in interface Api.Delete<EstimateItem.Category>

Specified by:

delete in interface EstimateItemCategoriesApi

Parameters:

categoryReference - a reference to the EstimateItemCategory to be deleted