CellFilter

Method Summary
CellFilter	addAnd() Adds an 'AND' clause to the filter.
CellFilter	addOr() Adds an 'OR' clause to the filter.
CellFilter	ascendDate() Sorts the result ascending by date
CellFilter	ascendId() Sorts the result ascending by id
CellFilter	ascendName() Sorts the result ascending by name
CellFilter	ascendSort() Sorts the result ascending by sortOrder
CellFilter	beginGroup() Adds a group clause to the filter.
CellFilter	descendDate() Sorts the result descending by date
CellFilter	descendId() Sorts the result descending by id
CellFilter	descendName() Sorts the result descending by name
CellFilter	descendSort() Sorts the result descending by sortOrder
CellFilter	endGroup() Ends a group clause.
CellFilter	likeExtra(String extra) Filters like extra. Default search is %extra%.
CellFilter	likeName(String name) Filters like name. Default search is %name%.
CellFilter	reset() Removes all criteria from the filter.
CellFilter	setOffset(long offset) Sets the page offset. Use 0 for the first record.
CellFilter	setPageSize(int pageSize) Sets the page size. Default is 100, minimum is 1 and maximum is 100,000.
	setQueryTimeout(int timeout) Sets the timeout for the query. By default this is 10 seconds and the maximum is defined by the cloud configuration.
String	toString() Returns a description of this object.
CellFilter	withDate(Date date) Filters by date.
CellFilter	withDateRange(Date startDate, Date endDate) Filters by date range.
CellFilter	withExtra(String extra) Filters by extra.
CellFilter	withId(String cellId) Filters for cells with the specified cellId.
CellFilter	withName(String name) Filters by name.
CellFilter	withParent(Cell parentCell) Filters by parent cell Id.
CellFilter	withProfileId(String profileId) Filters by profileId.
CellFilter	withSlice(String slice) Filters by main slice if this filter was created from a secondary slice, otherwise it is ignored.
CellFilter	withStatus(String status) Filters by status.

Method Detail

---

CellFilter addAnd()

Adds an 'AND' clause to the filter.

Returns:  CellFilter

Since: 08-12-2019

---

CellFilter addOr()

Adds an 'OR' clause to the filter.

Returns:  CellFilter

Since: 08-12-2019

---

CellFilter ascendDate()

Sorts the result ascending by date

Returns:  CellFilter

Since: 07-25-2019

---

CellFilter ascendId()

Sorts the result ascending by id

Returns:  CellFilter

Since: 08-20-2019

---

CellFilter ascendName()

Sorts the result ascending by name

Returns:  CellFilter

Since: 07-25-2019

---

CellFilter ascendSort()

Sorts the result ascending by sortOrder

Returns:  CellFilter

Since: 07-25-2019

---

CellFilter beginGroup()

Adds a group clause to the filter.

Returns:  CellFilter

Since: 08-12-2019

---

CellFilter descendDate()

Sorts the result descending by date

Returns:  CellFilter

Since: 07-25-2019

---

CellFilter descendId()

Sorts the result descending by id

Returns:  CellFilter

Since: 08-20-2019

---

CellFilter descendName()

Sorts the result descending by name

Returns:  CellFilter

Since: 07-25-2019

---

CellFilter descendSort()

Sorts the result descending by sortOrder

Returns:  CellFilter

Since: 07-25-2019

---

CellFilter endGroup()

Ends a group clause.

Returns:  CellFilter

Since: 08-12-2019

---

CellFilter likeExtra(String extra)

Filters like extra. Default search is %extra%.

Parameters:

• String   extra Required parameter.

Returns:  CellFilter

Since: 08-23-2019

---

CellFilter likeName(String name)

Filters like name. Default search is %name%.

Parameters:

• String   name Required parameter.

Returns:  CellFilter

Since: 08-23-2019

---

CellFilter reset()

Removes all criteria from the filter.

Returns:  CellFilter

Since: 08-12-2019

---

CellFilter setOffset(long offset)

Sets the page offset. Use 0 for the first record.

Parameters:

• long   offset  - Use 0 for no offset. Required parameter.

Returns:  CellFilter

Since: 07-25-2019

---

CellFilter setPageSize(int pageSize)

Sets the page size. Default is 100, minimum is 1 and maximum is 100,000.

Parameters:

• int   pageSize Required parameter.

Returns:  CellFilter

Since: 07-25-2019

---

setQueryTimeout(int timeout)

Sets the timeout for the query. By default this is 10 seconds and the maximum is defined by the cloud configuration.

Parameters:

• int   timeout

Since: 08-23-2019

---

String toString()

Returns a description of this object.

Returns:  String

Since: 07-25-2019

---

CellFilter withDate(Date date)

Filters by date.

Parameters:

• Date   date Required parameter.

Returns:  CellFilter

Since: 07-25-2019

---

CellFilter withDateRange(Date startDate, Date endDate)

Filters by date range.

Parameters:

• Date   startDate Required parameter.
• Date   endDate Required parameter.

Returns:  CellFilter

Since: 07-25-2019

---

CellFilter withExtra(String extra)

Filters by extra.

Parameters:

• String   extra Required parameter.

Returns:  CellFilter

Since: 08-09-2019

---

CellFilter withId(String cellId)

Filters for cells with the specified cellId.

Parameters:

• String   cellId Required parameter.

Returns:  CellFilter

Since: 10-03-2019

---

CellFilter withName(String name)

Filters by name.

Parameters:

• String   name Required parameter.

Returns:  CellFilter

Since: 07-25-2019

---

CellFilter withParent(Cell parentCell)

Filters by parent cell Id.

Parameters:

• Cell   parentCell Required parameter.

Returns:  CellFilter

Since: 08-19-2019

---

CellFilter withProfileId(String profileId)

Filters by profileId.

Parameters:

• String   profileId Required parameter.

Returns:  CellFilter

Since: 07-25-2019

---

CellFilter withSlice(String slice)

Filters by main slice if this filter was created from a secondary slice, otherwise it is ignored.

Parameters:

• String   slice Required parameter.

Returns:  CellFilter

Since: 08-13-2019

---

CellFilter withStatus(String status)

Filters by status.

Parameters:

• String   status Required parameter.

Returns:  CellFilter

Since: 07-25-2019