oracle.webcenter.activitystreaming

Interface DisplayOptions

public interface DisplayOptions

Display options are query criteria that affect or limit the number of activities returned

Method Summary

Modifier and Type	Method and Description
int	getBatchSize() Retrieve the batch size of the query.
java.util.Date	getEndDate() Return the end date criteria
int	getFirstResult() Return the first index criteria
int	getHeaderIndex() Retrieve the header index.
int	getMaxResults() Return the max results criteria
boolean	getPageForward() Retrieve the flag that indicates if it is for next page.
java.util.Date	getStartDate() Return the start date criteria
int	getTailIndex() Retrieve the tail index.
boolean	isAscending() Return whether results are in ascending order
void	setAscending(boolean ascending) Set whether results are in ascending order
void	setBatchSize(int size) Set the batch size of the query.
void	setEndDate(java.util.Date endDate) Set the end date criteria
void	setFirstResult(int startPosition) Set the first index criteria
void	setHeaderIndex(int headerIndex) Set the header index criteria.
void	setMaxResults(int maxResults) Set the max results criteria
void	setPageForward(boolean pageForward) Set the flag that indicates if it is for next page.
void	setStartDate(java.util.Date startDate) Set the start date criteria
void	setTailIndex(int tailIndex) Set the tail index.

Method Detail

setStartDate

void setStartDate(java.util.Date startDate)

Set the start date criteria

Parameters:

startDate - the start date to be set

getStartDate

java.util.Date getStartDate()

Return the start date criteria

Returns:

the start date of the criteria.

setEndDate

void setEndDate(java.util.Date endDate)

Set the end date criteria

Parameters:

endDate -

getEndDate

java.util.Date getEndDate()

Return the end date criteria

Returns:

the end date of the criteria.

setFirstResult

void setFirstResult(int startPosition)

Set the first index criteria

Parameters:

startPosition -

getFirstResult

int getFirstResult()

Return the first index criteria

Returns:

the first index criteria.

setMaxResults

void setMaxResults(int maxResults)

Set the max results criteria

Parameters:

maxResults -

getMaxResults

int getMaxResults()

Return the max results criteria

Returns:

the max results criteria.

setAscending

void setAscending(boolean ascending)

Set whether results are in ascending order

Parameters:

ascending -

isAscending

boolean isAscending()

Return whether results are in ascending order

Returns:

true if the order is ascending, false if not.

setHeaderIndex

void setHeaderIndex(int headerIndex)

Set the header index criteria. When the object security (processed in midtier) is enabled, the header index and tail index will mark the start and end index for the query that returns the result set of the batch size. For example, the header index is 20, tail index is 100 and the batch size is 30. This means in a result set from a query, between index 20 and 100, there are 30 rows that meet the object security criteria, others that don't meet the object security criteria will be filtered out.

Parameters:

headerIndex - The header index

getHeaderIndex

int getHeaderIndex()

Retrieve the header index.

Returns:

the header index.

See Also:

setHeaderIndex(int)

setTailIndex

void setTailIndex(int tailIndex)

Set the tail index.

Parameters:

tailIndex - The tail index.

See Also:

setHeaderIndex(int)

getTailIndex

int getTailIndex()

Retrieve the tail index.

Returns:

The tail index.

See Also:

setHeaderIndex(int)

setPageForward

void setPageForward(boolean pageForward)

Set the flag that indicates if it is for next page.

Parameters:

pageForward -

getPageForward

boolean getPageForward()

Retrieve the flag that indicates if it is for next page.

Returns:

true for next page, false for previous page.

setBatchSize

void setBatchSize(int size)

Set the batch size of the query.

Parameters:

size - The batch size of the query.

getBatchSize

int getBatchSize()

Retrieve the batch size of the query.

Returns:

The batch size of the query.