org.osid.financials.posting

Interface PostSearchOrder

All Superinterfaces:

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

public interface PostSearchOrder
extends OsidObjectSearchOrder, OsidAggregateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
PostSearchOrder	getCorrectedPostSearchOrder() Gets the post search order.
FiscalPeriodSearchOrder	getFiscalPeriodSearchOrder() Gets the fiscal period search order.
PostSearchOrderRecord	getPostSearchOrderRecord(Type postRecordType) Gets the post search order record corresponding to the given post record Type.
void	orderByCorrectedPost(SearchOrderStyle style) Specifies a preference for ordering the result set by the corrected post.
void	orderByDate(SearchOrderStyle style) Specifies a preference for ordering the result set by date.
void	orderByFiscalPeriod(SearchOrderStyle style) Specifies a preference for ordering the result set by fiscal period.
void	orderByPosted(SearchOrderStyle style) Specifies a preference for ordering the result set by the posted status.
boolean	supportsCorrectedPostSearchOrder() Tests if a post search order is available.
boolean	supportsFiscalPeriodSearchOrder() Tests if a fiscal period search order is available.

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

orderByFiscalPeriod

void orderByFiscalPeriod(SearchOrderStyle style)

Specifies a preference for ordering the result set by 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 fiscal period search order is available.

Returns:

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

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.

orderByPosted

void orderByPosted(SearchOrderStyle style)

Specifies a preference for ordering the result set by the posted status.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDate

void orderByDate(SearchOrderStyle style)

Specifies a preference for ordering the result set by date.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCorrectedPost

void orderByCorrectedPost(SearchOrderStyle style)

Specifies a preference for ordering the result set by the corrected post.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsCorrectedPostSearchOrder

boolean supportsCorrectedPostSearchOrder()

Tests if a post search order is available.

Returns:

true if a post search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCorrectedPostSearchOrder

PostSearchOrder getCorrectedPostSearchOrder()

Gets the post search order.

Returns:

the corrected post search order

Throws:

UnimplementedException - supportsCorrectedPostSearchOrder() is false

Compliance:

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

getPostSearchOrderRecord

PostSearchOrderRecord getPostSearchOrderRecord(Type postRecordType)
                                               throws OperationFailedException

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

Parameters:

postRecordType - a post record type

Returns:

the post search order record

Throws:

NullArgumentException - postRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(postRecordType) is false

Compliance:

mandatory - This method must be implemented.