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

An interface for specifying the ordering of search results.

MethodorderByPost
Description

Specifies a preference for ordering the result set by post.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsPostSearchOrder
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.
MethodgetPostSearchOrder
Description

Gets the post order.

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

Specifies a preference for ordering the result set by account.

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

Tests if an account search order is available.

Returnboolean true if an search account order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAccountSearchOrder
Description

Gets the account order.

Returnosid.financials.AccountSearchOrderthe account search order
ErrorsUNIMPLEMENTED supportsAccountSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsAccountSearchOrder() is true.
MethodorderByActivity
Description

Specifies a preference for ordering the result set by activity.

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

Tests if an activity search order is available.

Returnboolean true if an activity search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetActivitySearchOrder
Description

Gets the activity search order.

Returnosid.financials.ActivitySearchOrderthe activity search order
ErrorsUNIMPLEMENTED supportsActivitySearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsActivitySearchOrder() is true.
MethodorderByAmount
Description

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

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

Specifies a preference for ordering the result set by the debit flag.

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

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

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