Interface PeriodSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable

public interface PeriodSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
PeriodSearchOrderRecord	getPeriodSearchOrderRecord(Type periodRecordType)	Gets the period search order record corresponding to the given customer record Type .
void	orderByBillingDate(SearchOrderStyle style)	Specified a preference for ordering results by billing date.
void	orderByCloseDate(SearchOrderStyle style)	Specified a preference for ordering results by close date.
void	orderByDisplayLabel(SearchOrderStyle style)	Specifies a preference for ordering the result set by customer title.
void	orderByDueDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the due date.
void	orderByOpenDate(SearchOrderStyle style)	Specified a preference for ordering results by the open date.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Method Details

orderByDisplayLabel

void orderByDisplayLabel(SearchOrderStyle style)

Specifies a preference for ordering the result set by customer title.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByOpenDate

void orderByOpenDate(SearchOrderStyle style)

Specified a preference for ordering results by the open date.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCloseDate

void orderByCloseDate(SearchOrderStyle style)

Specified a preference for ordering results by close date.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByBillingDate

void orderByBillingDate(SearchOrderStyle style)

Specified a preference for ordering results by billing date.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDueDate

void orderByDueDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by the due date.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getPeriodSearchOrderRecord

PeriodSearchOrderRecord getPeriodSearchOrderRecord(Type periodRecordType)
                                            throws OperationFailedException

Gets the period search order record corresponding to the given customer record Type . Multiple retrievals return the same underlying object.

Parameters:

periodRecordType - a period record type

Returns:

the period search order record

Throws:

NullArgumentException - periodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(periodRecordType) is false

Compliance:

mandatory - This method must be implemented.