Interface | osid.financials.posting.PostSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidAggregateableSearchOrder | |||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByFiscalPeriod | ||
Description |
Specifies a preference for ordering the result set by fiscal period. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsFiscalPeriodSearchOrder | ||
Description |
Tests if a fiscal period search order is available. | ||
Return | boolean | true if a fiscal period search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getFiscalPeriodSearchOrder | ||
Description |
Gets the fiscal period search order. | ||
Return | osid.financials.FiscalPeriodSearchOrder | the fiscal period search order | |
Errors | UNIMPLEMENTED | supportsFiscalPeriodSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsFiscalPeriodSearchOrder()
is true. | |
Method | orderByPosted | ||
Description |
Specifies a preference for ordering the result set by the posted status. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByDate | ||
Description |
Specifies a preference for ordering the result set by date. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByCorrectedPost | ||
Description |
Specifies a preference for ordering the result set by the corrected post. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsCorrectedPostSearchOrder | ||
Description |
Tests if a post search order is available. | ||
Return | boolean | true if a post search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCorrectedPostSearchOrder | ||
Description |
Gets the post search order. | ||
Return | osid.financials.posting.PostSearchOrder | the corrected post search order | |
Errors | UNIMPLEMENTED | supportsCorrectedPostSearchOrder() is false | |
Compliance | optional | This method must be implemented if
supportsCorrectedPostSearchOrder() is true. | |
Method | getPostSearchOrderRecord | ||
Description |
Gets the post search order record corresponding to the
given post record | ||
Parameters | osid.type.Type | postRecordType | a post record type |
Return | osid.financials.posting.records.PostSearchOrderRecord | the post search order record | |
Errors | NULL_ARGUMENT | postRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(postRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |