org.osid.billing

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

Methods

Modifier and Type	Method and 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 org.osid.OsidObjectSearchOrder

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

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

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.