ch.aaap.harvestclient.impl

Class ClientContactsApiImpl

Object

ch.aaap.harvestclient.impl.ClientContactsApiImpl

All Implemented Interfaces:

Api.Create<ClientContact>, Api.Delete<ClientContact>, Api.Get<ClientContact>, Api.Simple<ClientContact>, ClientContactsApi

public class ClientContactsApiImpl
extends Object
implements ClientContactsApi

Constructor Summary

Constructors

Constructor and Description
ClientContactsApiImpl(ClientContactService service)

Method Summary

Modifier and Type	Method and Description
ClientContact	create(ClientContact clientContactCreationInfo) Create a new ClientContact according to given creation information.
void	delete(Reference<ClientContact> clientContactReference) Delete an existing ClientContact.
ClientContact	get(Reference<ClientContact> clientContactReference)
List<ClientContact>	list(ClientContactFilter filter) Return a list of clientContacts, sorted by creation date, newest first.
Pagination<ClientContact>	list(ClientContactFilter filter, int page, int perPage) Return a list of clientContacts, sorted by creation date, newest first.
ClientContact	update(Reference<ClientContact> clientContactReference, ClientContactUpdateInfo toChange) Updates an existing ClientContact with the properties set in ClientContactUpdateInfo

Methods inherited from class Object

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

Constructor Detail

ClientContactsApiImpl

public ClientContactsApiImpl(ClientContactService service)

Method Detail

list

public List<ClientContact> list(ClientContactFilter filter)

Description copied from interface: ClientContactsApi

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

Specified by:

list in interface ClientContactsApi

Parameters:

filter - filtering options

Returns:

a (filtered) list of ClientContacts

list

public Pagination<ClientContact> list(ClientContactFilter filter,
                                      int page,
                                      int perPage)

Description copied from interface: ClientContactsApi

Return a list of clientContacts, 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 ClientContactsApi

Parameters:

filter - filtering options

page - the page number

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

Returns:

a (filtered) list of ClientContacts

get

public ClientContact get(Reference<ClientContact> clientContactReference)

Specified by:

get in interface Api.Get<ClientContact>

Specified by:

get in interface ClientContactsApi

Parameters:

clientContactReference - a reference to an existing ClientContact

Returns:

Return a full ClientContact object

create

public ClientContact create(ClientContact clientContactCreationInfo)

Description copied from interface: ClientContactsApi

Create a new ClientContact according to given creation information.

Specified by:

create in interface Api.Create<ClientContact>

Specified by:

create in interface ClientContactsApi

Parameters:

clientContactCreationInfo - the creation options

Returns:

the newly created ClientContact

update

public ClientContact update(Reference<ClientContact> clientContactReference,
                            ClientContactUpdateInfo toChange)

Description copied from interface: ClientContactsApi

Updates an existing ClientContact with the properties set in ClientContactUpdateInfo

Specified by:

update in interface ClientContactsApi

Parameters:

clientContactReference - the existing clientContact to be updated

toChange - the properties to be updated

Returns:

the updated ClientContact

delete

public void delete(Reference<ClientContact> clientContactReference)

Description copied from interface: ClientContactsApi

Delete an existing ClientContact.

Specified by:

delete in interface Api.Delete<ClientContact>

Specified by:

delete in interface ClientContactsApi

Parameters:

clientContactReference - a reference to an existing ClientContact to be deleted