org.osid.financials

Interface FiscalPeriodSearchOrder

All Superinterfaces:

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

public interface FiscalPeriodSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
FiscalPeriodSearchOrderRecord	getFiscalPeriodSearchOrderRecord(Type fiscalPeriodRecordType) Gets the fiscal period search order record corresponding to the given fiscal period record Type.
void	orderByBudgetDeadline(SearchOrderStyle style) Specifies a preference for ordering the result set by the budget deadline.
void	orderByClosing(SearchOrderStyle style) Specifies a preference for ordering the result set by the closing date.
void	orderByDisplayLabel(SearchOrderStyle style) Specifies a preference for ordering the result set by display label.
void	orderByDuration(SearchOrderStyle style) Specifies a preference for ordering the result set by duration.
void	orderByEndDate(SearchOrderStyle style) Specifies a preference for ordering the result set by fiscal period end date.
void	orderByFiscalYear(SearchOrderStyle style) Specifies a preference for ordering the result set by year.
void	orderByPostingDeadline(SearchOrderStyle style) Specifies a preference for ordering the result set by the posting deadline.
void	orderByStartDate(SearchOrderStyle style) Specifies a preference for ordering the result set by fiscal period start 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 display label.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByFiscalYear

void orderByFiscalYear(SearchOrderStyle style)

Specifies a preference for ordering the result set by year.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByStartDate

void orderByStartDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by fiscal period start date.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByEndDate

void orderByEndDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by fiscal period end date.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDuration

void orderByDuration(SearchOrderStyle style)

Specifies a preference for ordering the result set by duration.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByBudgetDeadline

void orderByBudgetDeadline(SearchOrderStyle style)

Specifies a preference for ordering the result set by the budget deadline.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByPostingDeadline

void orderByPostingDeadline(SearchOrderStyle style)

Specifies a preference for ordering the result set by the posting deadline.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByClosing

void orderByClosing(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodSearchOrderRecord

FiscalPeriodSearchOrderRecord getFiscalPeriodSearchOrderRecord(Type fiscalPeriodRecordType)
                                                               throws OperationFailedException

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

Parameters:

fiscalPeriodRecordType - a fiscal period record type

Returns:

the fiscal period search order record

Throws:

NullArgumentException - fiscalPeriodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(fiscalPeriodRecordType) is false

Compliance:

mandatory - This method must be implemented.