org.osid.financials

Interface AccountSearchOrder

All Superinterfaces:

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

public interface AccountSearchOrder
extends OsidObjectSearchOrder, OsidFederateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
AccountSearchOrderRecord	getAccountSearchOrderRecord(Type accountRecordType) Gets the account search order record corresponding to the given account record Type.
void	orderByCode(SearchOrderStyle style) Specifies a preference for ordering the result set by the code.
void	orderByCreditBalance(SearchOrderStyle style) Specifies a preference for ordering the result set by the credit balance flag.

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

orderByCreditBalance

void orderByCreditBalance(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCode

void orderByCode(SearchOrderStyle style)

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

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getAccountSearchOrderRecord

AccountSearchOrderRecord getAccountSearchOrderRecord(Type accountRecordType)
                                                     throws OperationFailedException

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

Parameters:

accountRecordType - an account record type

Returns:

the account search order record

Throws:

NullArgumentException - accountRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(accountRecordType) is false

Compliance:

mandatory - This method must be implemented.