OSID Logo
OSID Specifications
financials budgeting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.budgeting.BudgetEntrySearchOrder
Implementsosid.OsidRelationshipSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByBudget
Description

Specifies a preference for ordering the result set by budget.

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

Tests if a budget search order is available.

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

Gets the budget order.

Returnosid.financials.budgeting.BudgetSearchOrderthe budget search order
ErrorsUNIMPLEMENTED supportsBudgetSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsBudgetSearchOrder() 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.
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.
MethodgetBudgetEntrySearchOrderRecord
Description

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

Parametersosid.type.TypebudgetEntryRecordTypea budget entry record type
Returnosid.financials.budgeting.records.BudgetEntrySearchOrderRecordthe budget entry search order record
ErrorsNULL_ARGUMENT budgetEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(budgetEntryRecordType) is false
CompliancemandatoryThis method must be implemented.