Package com.jalios.jcms.alert

Class AlertQueryBuilder

java.lang.Object

com.jalios.jcms.alert.AlertQueryBuilder

public class AlertQueryBuilder
extends java.lang.Object

Helper to query Alerts.

Since:

jcms-10.0

Author:

Sylvain Devaux

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AlertQueryBuilder.ReadMode	ReadMode represents the state of alert (Read, unread, read & unread)

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	RECIPIENT_EXCEPTION_EXPECTED_MESSAGE

Constructor Summary

Constructors

Constructor	Description
AlertQueryBuilder()
AlertQueryBuilder(AlertQueryBuilder other)

Method Summary

Modifier and Type	Method	Description
AlertQueryBuilder	author(Member author)	Sets the author to filter on current AlertQueryBuilder
AlertQueryBuilder	endDate(java.util.Calendar endCal)	Sets the endDate to filter on current AlertQueryBuilder
AlertQueryBuilder	endDate(java.util.Date endDate)	Sets the endDate to filter on current AlertQueryBuilder
PageResult<Alert>	getResults()	Returns alert paginated result
int	getResultsCount()	Count (without sorting and first/max criteria for performance reason)
AlertQueryBuilder	levels(Alert.Level... levels)	Sets the levels to filter on current AlertQueryBuilder
AlertQueryBuilder	pagerAll(boolean pagerAll)	Defines if all results should be displayed for current AlertQueryBuilder
void	pagerParams(PagerParams pagerParams)
AlertQueryBuilder	pageSize(int pageSize)	Sets the page size on current AlertQueryBuilder
AlertQueryBuilder	read(AlertQueryBuilder.ReadMode readMode)	Sets the read mode to filter on current AlertQueryBuilder
AlertQueryBuilder	recipient(Member recipient)	Sets the recipient to filter on current AlertQueryBuilder
AlertQueryBuilder	reverse(boolean reverse)	Defines if results have to be reversed on current AlertQueryBuilder
AlertQueryBuilder	sort(java.lang.String sort)	Sets the sort on current AlertQueryBuilder
AlertQueryBuilder	start(int start)	Sets the start (Index) on current AlertQueryBuilder
AlertQueryBuilder	startDate(java.util.Calendar startCal)	Sets the startDate to filter on current AlertQueryBuilder
AlertQueryBuilder	startDate(java.util.Date startDate)	Sets the startDate to filter on current AlertQueryBuilder
java.lang.String	toString()
AlertQueryBuilder	workspace(Workspace workspace)	Sets the workspace to filter on current AlertQueryBuilder

Methods inherited from class java.lang.Object

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

Field Detail

RECIPIENT_EXCEPTION_EXPECTED_MESSAGE

protected static final java.lang.String RECIPIENT_EXCEPTION_EXPECTED_MESSAGE

See Also:

Constant Field Values

Constructor Detail

AlertQueryBuilder

public AlertQueryBuilder()

AlertQueryBuilder

public AlertQueryBuilder(AlertQueryBuilder other)

Method Detail

getResultsCount

public int getResultsCount()

Count (without sorting and first/max criteria for performance reason)

Returns:

results count for current user filters

Throws:

java.lang.IllegalArgumentException - if recipient is null

getResults

public PageResult<Alert> getResults()

Returns alert paginated result

Returns:

results as a PageResult of Alert

Throws:

java.lang.IllegalArgumentException - if recipient is null

author

public AlertQueryBuilder author(Member author)

Sets the author to filter on current AlertQueryBuilder

Parameters:

author - the Member author of the alert

Returns:

a reference to this object

endDate

public AlertQueryBuilder endDate(java.util.Date endDate)

Sets the endDate to filter on current AlertQueryBuilder

Parameters:

endDate - the Date

Returns:

a reference to this object

endDate

public AlertQueryBuilder endDate(java.util.Calendar endCal)

Sets the endDate to filter on current AlertQueryBuilder

Parameters:

endCal - the Calendar

Returns:

a reference to this object

levels

public AlertQueryBuilder levels(Alert.Level... levels)

Sets the levels to filter on current AlertQueryBuilder

Parameters:

levels - the array of Alert.Level

Returns:

a reference to this object

recipient

public AlertQueryBuilder recipient(Member recipient)

Sets the recipient to filter on current AlertQueryBuilder

Parameters:

recipient - the Member

Returns:

a reference to this object

read

public AlertQueryBuilder read(AlertQueryBuilder.ReadMode readMode)

Sets the read mode to filter on current AlertQueryBuilder

Parameters:

readMode - the AlertQueryBuilder.ReadMode

Returns:

a reference to this object

startDate

public AlertQueryBuilder startDate(java.util.Date startDate)

Sets the startDate to filter on current AlertQueryBuilder

Parameters:

startDate - the Date

Returns:

a reference to this object

startDate

public AlertQueryBuilder startDate(java.util.Calendar startCal)

Sets the startDate to filter on current AlertQueryBuilder

Parameters:

startCal - the Calendar

Returns:

a reference to this object

workspace

public AlertQueryBuilder workspace(Workspace workspace)

Sets the workspace to filter on current AlertQueryBuilder

Parameters:

workspace - the Workspace

Returns:

a reference to this object

pagerParams

public void pagerParams(PagerParams pagerParams)

sort

public AlertQueryBuilder sort(java.lang.String sort)

Sets the sort on current AlertQueryBuilder

Parameters:

sort - the chosen sort on current AlertQueryBuilder

Returns:

a reference to this object

reverse

public AlertQueryBuilder reverse(boolean reverse)

Defines if results have to be reversed on current AlertQueryBuilder

Parameters:

reverse - if true results order will be reversed

Returns:

a reference to this object

start

public AlertQueryBuilder start(int start)

Sets the start (Index) on current AlertQueryBuilder

Parameters:

start - the first index

Returns:

a reference to this object

pageSize

public AlertQueryBuilder pageSize(int pageSize)

Sets the page size on current AlertQueryBuilder

Parameters:

pageSize - the page size for returned PageResult

Returns:

a reference to this object

pagerAll

public AlertQueryBuilder pagerAll(boolean pagerAll)

Defines if all results should be displayed for current AlertQueryBuilder

Parameters:

pagerAll - if true all results will be displayed

Returns:

a reference to this object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object