oracle.webcenter.notification

Class SortOption

java.lang.Object

oracle.webcenter.notification.SortOption

public class SortOption
extends java.lang.Object

Defines the sort attributes for fetching subscriptions. Instance of this class can be used in SubscriptionManager methods to query a user's subscriptions.

See Also:

SubscriptionManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SortOption.SortBy Enum that defines the supported fields for sorting.

Constructor Summary

Constructors

Constructor and Description
SortOption() Constructor to create an instance of this class.

Method Summary

Modifier and Type	Method and Description
SortOption.SortBy	getField() Returns the sort field of this object.
boolean	isAscending() Returns whether the sort order is ascending or descending.
void	setAscending(boolean mAscending) Sets the sorting order for this object to be used with the sort by field.
void	setField(SortOption.SortBy sortBy) Sets the sort field of this object to one of the supported field as defined by SortBy

Methods inherited from class java.lang.Object

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

Constructor Detail

SortOption

public SortOption()

Constructor to create an instance of this class.

Method Detail

setField

public void setField(SortOption.SortBy sortBy)

Sets the sort field of this object to one of the supported field as defined by SortBy

Parameters:

- - the sort by field to be set for this object.

getField

public SortOption.SortBy getField()

Returns the sort field of this object.

Returns:

- the sort by field of this object.

setAscending

public void setAscending(boolean mAscending)

Sets the sorting order for this object to be used with the sort by field.

Parameters:

- - whether the order of sort field in setField is ascending or descending. If true, ascending, otherwise descending.

isAscending

public boolean isAscending()

Returns whether the sort order is ascending or descending.

Returns:

- true if ascending, false otherwise.