OSID Logo
OSID Specifications
financials posting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.posting.PostSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidAggregateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByFiscalPeriod
Description

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsFiscalPeriodSearchOrder
Description

Tests if a fiscal period search order is available.

Returnboolean true if a fiscal period search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodSearchOrder
Description

Gets the fiscal period search order.

Returnosid.financials.FiscalPeriodSearchOrderthe fiscal period search order
ErrorsUNIMPLEMENTED supportsFiscalPeriodSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsFiscalPeriodSearchOrder() is true.
MethodorderByPosted
Description

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByDate
Description

Specifies a preference for ordering the result set by date.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByCorrectedPost
Description

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsCorrectedPostSearchOrder
Description

Tests if a post search order is available.

Returnboolean true if a post search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCorrectedPostSearchOrder
Description

Gets the post search order.

Returnosid.financials.posting.PostSearchOrderthe corrected post search order
ErrorsUNIMPLEMENTED supportsCorrectedPostSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsCorrectedPostSearchOrder() is true.
MethodgetPostSearchOrderRecord
Description

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

Parametersosid.type.TypepostRecordTypea post record type
Returnosid.financials.posting.records.PostSearchOrderRecordthe post search order record
ErrorsNULL_ARGUMENT postRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(postRecordType) is false
CompliancemandatoryThis method must be implemented.