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

An interface for specifying the ordering of search results.

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.
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.
MethodgetBudgetSearchOrderRecord
Description

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

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