OSID Specifications
financials package
Version 3.1.0
financials package
Version 3.1.0
| Interface | osid.financials.FiscalPeriodQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidObjectQueryInspector | ||
| Used By | osid.financials.BusinessQueryInspector | ||
osid.financials.FiscalPeriodSearchResults | |||
osid.financials.FiscalPeriodSmartBusinessSession | |||
osid.financials.SummaryQueryInspector | |||
osid.financials.budgeting.BudgetQueryInspector | |||
osid.financials.posting.PostQueryInspector | |||
| 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
| ||
| Method | getDisplayLabelTerms | ||
| Description |
Gets the display label query terms. | ||
| Return | osid.search.terms.StringTerm[] | the display label terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFiscalYearTerms | ||
| Description |
Gets the fiscal year query terms. | ||
| Return | osid.search.terms.IntegerRangeTerm[] | the fiscal year terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStartDateTerms | ||
| Description |
Gets the start date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the start date query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEndDateTerms | ||
| Description |
Gets the end date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the end date query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDurationTerms | ||
| Description |
Gets the duration query terms. | ||
| Return | osid.search.terms.DurationRangeTerm[] | the duration query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBudgetDeadlineTerms | ||
| Description |
Gets the budget deadline query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the budget deadline query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostingDeadlineTerms | ||
| Description |
Gets the posting deadline query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the posting deadline query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getClosingTerms | ||
| Description |
Gets the closing query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the closing query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBusinessIdTerms | ||
| Description |
Gets the business | ||
| Return | osid.search.terms.IdTerm[] | the business Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBusinessTerms | ||
| Description |
Gets the business query terms. | ||
| Return | osid.financials.BusinessQueryInspector[] | the business query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFiscalPeriodQueryInspectorRecord | ||
| Description |
Gets the fiscal period query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | fiscalPeriodRecordType | a fiscal period record type |
| Return | osid.financials.records.FiscalPeriodQueryInspectorRecord | the fiscal period query inspector record | |
| Errors | NULL_ARGUMENT | fiscalPeriodRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(fiscalPeriodRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |