OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.FiscalPeriodQueryInspector
Implementsosid.OsidObjectQueryInspector
Description

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to OsidQuery interfaces for reuse or modification in the search sessions.

MethodgetDisplayLabelTerms
Description

Gets the display label query terms.

Returnosid.search.terms.StringTerm[]the display label terms
CompliancemandatoryThis method must be implemented.
MethodgetFiscalYearTerms
Description

Gets the fiscal year query terms.

Returnosid.search.terms.IntegerRangeTerm[]the fiscal year terms
CompliancemandatoryThis method must be implemented.
MethodgetStartDateTerms
Description

Gets the start date query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the start date query terms
CompliancemandatoryThis method must be implemented.
MethodgetEndDateTerms
Description

Gets the end date query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the end date query terms
CompliancemandatoryThis method must be implemented.
MethodgetDurationTerms
Description

Gets the duration query terms.

Returnosid.search.terms.DurationRangeTerm[]the duration query terms
CompliancemandatoryThis method must be implemented.
MethodgetBudgetDeadlineTerms
Description

Gets the budget deadline query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the budget deadline query terms
CompliancemandatoryThis method must be implemented.
MethodgetPostingDeadlineTerms
Description

Gets the posting deadline query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the posting deadline query terms
CompliancemandatoryThis method must be implemented.
MethodgetClosingTerms
Description

Gets the closing query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the closing query terms
CompliancemandatoryThis method must be implemented.
MethodgetBusinessIdTerms
Description

Gets the business Id query terms.

Returnosid.search.terms.IdTerm[]the business Id query terms
CompliancemandatoryThis method must be implemented.
MethodgetBusinessTerms
Description

Gets the business query terms.

Returnosid.financials.BusinessQueryInspector[]the business query terms
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodQueryInspectorRecord
Description

Gets the fiscal period query inspector record corresponding to the given FiscalPeriod record Type. Multiple record retrievals produce a nested OR term.

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