org.osid.financials

Interface SummarySearchOrder

All Superinterfaces:

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

public interface SummarySearchOrder
extends OsidCompendiumSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AccountSearchOrder	getAccountSearchOrder() Gets the account search order.
FiscalPeriodSearchOrder	getFiscalPeriodSearchOrder() Gets the fiscal period search order.
SummarySearchOrderRecord	getSummarySearchOrderRecord(Type summaryRecordType) Gets the fiscal period search order record corresponding to the given fiscal period record Type.
void	orderByAccount(SearchOrderStyle style) Specifies a preference for ordering the result set by the account.
void	orderByBalance(SearchOrderStyle style) Specifies a preference for ordering the result set by the balance.
void	orderByBudget(SearchOrderStyle style) Specifies a preference for ordering the result set by the budget
void	orderByCredits(SearchOrderStyle style) Specifies a preference for ordering the result set by the credits.
void	orderByDebits(SearchOrderStyle style) Specifies a preference for ordering the result set by the debits.
void	orderByDelta(SearchOrderStyle style) Specifies a preference for ordering the result set by the delta.
void	orderByFiscalPeriod(SearchOrderStyle style) Specifies a preference for ordering the result set by the fiscal period.
void	orderByForecast(SearchOrderStyle style) Specifies a preference for ordering the result set by the forecast.
boolean	supportsAccountSearchOrder() Tests if an AccountSearchOrder is available.
boolean	supportsFiscalPeriodSearchOrder() Tests if a FiscalPeriodSearchOrder is available.

Methods inherited from interface org.osid.OsidCompendiumSearchOrder

orderByEndDate, orderByExtrapolated, orderByInterpolated, orderByStartDate

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

orderByAccount

void orderByAccount(SearchOrderStyle style)

Specifies a preference for ordering the result set by the account.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsAccountSearchOrder

boolean supportsAccountSearchOrder()

Tests if an AccountSearchOrder is available.

Returns:

true if an account search order is available, false otherwise

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getAccountSearchOrder

AccountSearchOrder getAccountSearchOrder()

Gets the account search order.

Returns:

the account search order

Throws:

UnimplementedException - supportsAccountSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsAccountSearchOrder() is true.

orderByFiscalPeriod

void orderByFiscalPeriod(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsFiscalPeriodSearchOrder

boolean supportsFiscalPeriodSearchOrder()

Tests if a FiscalPeriodSearchOrder is available.

Returns:

true if a fiscal period search order is available, false otherwise

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodSearchOrder

FiscalPeriodSearchOrder getFiscalPeriodSearchOrder()

Gets the fiscal period search order.

Returns:

the fiscal period search order

Throws:

UnimplementedException - supportsFiscalPeriodSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodSearchOrder() is true.

orderByCredits

void orderByCredits(SearchOrderStyle style)

Specifies a preference for ordering the result set by the credits.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDebits

void orderByDebits(SearchOrderStyle style)

Specifies a preference for ordering the result set by the debits.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByBalance

void orderByBalance(SearchOrderStyle style)

Specifies a preference for ordering the result set by the balance.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByBudget

void orderByBudget(SearchOrderStyle style)

Specifies a preference for ordering the result set by the budget

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDelta

void orderByDelta(SearchOrderStyle style)

Specifies a preference for ordering the result set by the delta.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByForecast

void orderByForecast(SearchOrderStyle style)

Specifies a preference for ordering the result set by the forecast.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getSummarySearchOrderRecord

SummarySearchOrderRecord getSummarySearchOrderRecord(Type summaryRecordType)
                                                     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:

summaryRecordType - a summary record type

Returns:

the summary search order record

Throws:

NullArgumentException - summaryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(summaryRecordType) is false

Compliance:

mandatory - This method must be implemented.