OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.FiscalPeriodSearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByDisplayLabel
Description

Specifies a preference for ordering the result set by display label.

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

Specifies a preference for ordering the result set by year.

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

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

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

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

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

Specifies a preference for ordering the result set by duration.

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

Specifies a preference for ordering the result set by the budget deadline.

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

Specifies a preference for ordering the result set by the posting deadline.

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

Specifies a preference for ordering the result set by the closing date.

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

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

Parametersosid.type.TypefiscalPeriodRecordTypea fiscal period record type
Returnosid.financials.records.FiscalPeriodSearchOrderRecordthe fiscal period search order record
ErrorsNULL_ARGUMENT fiscalPeriodRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(fiscalPeriodRecordType) is false
CompliancemandatoryThis method must be implemented.