ch.aaap.harvestclient.api

Interface ClientContactsApi

All Known Implementing Classes:

ClientContactsApiImpl

public interface ClientContactsApi

Method Summary

Modifier and Type	Method and Description
ClientContact	create(ClientContactCreationInfo 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.
ClientContact	update(Reference<ClientContact> clientContactReference, ClientContactUpdateInfo toChange) Updates an existing ClientContact with the properties set in ClientContactUpdateInfo

Method Detail

list

List<ClientContact> list(ClientContactFilter filter)

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

Parameters:

filter - filtering options

Returns:

a (filtered) list of ClientContacts

get

ClientContact get(Reference<ClientContact> clientContactReference)

Parameters:

clientContactReference - a reference to an existing ClientContact

Returns:

Return a full ClientContact object

create

ClientContact create(ClientContactCreationInfo clientContactCreationInfo)

Create a new ClientContact according to given creation information.

Parameters:

clientContactCreationInfo - the creation options

Returns:

the newly created ClientContact

update

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

Updates an existing ClientContact with the properties set in ClientContactUpdateInfo

Parameters:

clientContactReference - the existing clientContact to be updated

toChange - the properties to be updated

Returns:

the updated ClientContact

delete

void delete(Reference<ClientContact> clientContactReference)

Delete an existing ClientContact.

Parameters:

clientContactReference - a reference to an existing ClientContact to be deleted