Package de.focus_shift.lexoffice.java.sdk.chain

Class ContactChain.Fetch

java.lang.Object

de.focus_shift.lexoffice.java.sdk.chain.ContactChain.Fetch

Enclosing class:

ContactChain

public static class ContactChain.Fetch
extends Object

Constructor Summary

Constructors

Constructor	Description
Fetch(RequestContext context)

Method Summary

Modifier and Type	Method	Description
ContactChain.Fetch	customer(boolean customer)	if set to true filters contacts that have the role customer.
ContactChain.Fetch	email(String email)	filters contacts where any of their email addresses inside the emailAddresses JSON object match the given email value.
Page<Contact>	get()
protected RequestContext	getContext()
protected RestUriBuilder	getUriBuilder()
ContactChain.Fetch	name(String name)	filters contacts whose name matches the given name value.
ContactChain.Fetch	number(Long number)	returns the contacts with the specified contact number.
ContactChain.Fetch	page(int page)	Pages are zero indexed, thus providing 0 for page will return the first page.
ContactChain.Fetch	pageSize(int pageSize)	Default page size is set to 25 but can be increased up to 100/250 (depends on the used endpoint).
protected String	resolvePath()
ContactChain.Fetch	vendor(boolean vendor)	if set to true filters contacts that have the role vendor.

Methods inherited from class java.lang.Object

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

Constructor Details

Fetch

public Fetch(RequestContext context)

Method Details

page

public ContactChain.Fetch page(int page)

Pages are zero indexed, thus providing 0 for page will return the first page.

pageSize

public ContactChain.Fetch pageSize(int pageSize)

Default page size is set to 25 but can be increased up to 100/250 (depends on the used endpoint).

email

public ContactChain.Fetch email(String email)

filters contacts where any of their email addresses inside the emailAddresses JSON object match the given email value. At least 3 characters are necessary to successfully complete the query.

name

public ContactChain.Fetch name(String name)

filters contacts whose name matches the given name value. At least 3 characters are necessary to successfully complete the query.

number

public ContactChain.Fetch number(Long number)

returns the contacts with the specified contact number. Number is either the customer number or the vendor number located in the roles object.

customer

public ContactChain.Fetch customer(boolean customer)

if set to true filters contacts that have the role customer. If set to false filters contacts that do not have the customer role.

vendor

public ContactChain.Fetch vendor(boolean vendor)

if set to true filters contacts that have the role vendor. If set to false filters contacts that do not have the vendor role.

get

public Page<Contact> get()

getUriBuilder

protected RestUriBuilder getUriBuilder()

resolvePath

protected String resolvePath()

getContext

protected RequestContext getContext()