org.osid.financials

Interface FiscalPeriodQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface FiscalPeriodQueryInspector
extends OsidObjectQueryInspector

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.

Method Summary

Methods

Modifier and Type	Method and Description
DateTimeRangeTerm[]	getBudgetDeadlineTerms() Gets the budget deadline query terms.
IdTerm[]	getBusinessIdTerms() Gets the business Id query terms.
BusinessQueryInspector[]	getBusinessTerms() Gets the business query terms.
DateTimeRangeTerm[]	getClosingTerms() Gets the closing query terms.
StringTerm[]	getDisplayLabelTerms() Gets the display label query terms.
DurationRangeTerm[]	getDurationTerms() Gets the duration query terms.
DateTimeRangeTerm[]	getEndDateTerms() Gets the end date query terms.
FiscalPeriodQueryInspectorRecord	getFiscalPeriodQueryInspectorRecord(Type fiscalPeriodRecordType) Gets the fiscal period query inspector record corresponding to the given FiscalPeriod record Type.
IntegerRangeTerm[]	getFiscalYearTerms() Gets the fiscal year query terms.
DateTimeRangeTerm[]	getPostingDeadlineTerms() Gets the posting deadline query terms.
DateTimeRangeTerm[]	getStartDateTerms() Gets the start date query terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Method Detail

getDisplayLabelTerms

StringTerm[] getDisplayLabelTerms()

Gets the display label query terms.

Returns:

the display label terms

Compliance:

mandatory - This method must be implemented.

getFiscalYearTerms

IntegerRangeTerm[] getFiscalYearTerms()

Gets the fiscal year query terms.

Returns:

the fiscal year terms

Compliance:

mandatory - This method must be implemented.

getStartDateTerms

DateTimeRangeTerm[] getStartDateTerms()

Gets the start date query terms.

Returns:

the start date query terms

Compliance:

mandatory - This method must be implemented.

getEndDateTerms

DateTimeRangeTerm[] getEndDateTerms()

Gets the end date query terms.

Returns:

the end date query terms

Compliance:

mandatory - This method must be implemented.

getDurationTerms

DurationRangeTerm[] getDurationTerms()

Gets the duration query terms.

Returns:

the duration query terms

Compliance:

mandatory - This method must be implemented.

getBudgetDeadlineTerms

DateTimeRangeTerm[] getBudgetDeadlineTerms()

Gets the budget deadline query terms.

Returns:

the budget deadline query terms

Compliance:

mandatory - This method must be implemented.

getPostingDeadlineTerms

DateTimeRangeTerm[] getPostingDeadlineTerms()

Gets the posting deadline query terms.

Returns:

the posting deadline query terms

Compliance:

mandatory - This method must be implemented.

getClosingTerms

DateTimeRangeTerm[] getClosingTerms()

Gets the closing query terms.

Returns:

the closing query terms

Compliance:

mandatory - This method must be implemented.

getBusinessIdTerms

IdTerm[] getBusinessIdTerms()

Gets the business Id query terms.

Returns:

the business Id query terms

Compliance:

mandatory - This method must be implemented.

getBusinessTerms

BusinessQueryInspector[] getBusinessTerms()

Gets the business query terms.

Returns:

the business query terms

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodQueryInspectorRecord

FiscalPeriodQueryInspectorRecord getFiscalPeriodQueryInspectorRecord(Type fiscalPeriodRecordType)
                                                                     throws OperationFailedException

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

Parameters:

fiscalPeriodRecordType - a fiscal period record type

Returns:

the fiscal period query inspector record

Throws:

NullArgumentException - fiscalPeriodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(fiscalPeriodRecordType) is false

Compliance:

mandatory - This method must be implemented.