org.osid.billing

Interface PeriodQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface PeriodQueryInspector
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[]	getBillingDateTerms() Gets the billing date query terms.
IdTerm[]	getBusinessIdTerms() Gets the business Id query terms.
BusinessQueryInspector[]	getBusinessTerms() Gets the business query terms.
DateTimeRangeTerm[]	getCloseDateTerms() Gets the close date query terms.
StringTerm[]	getDisplayLabelTerms() Gets the display label query terms.
DateTimeRangeTerm[]	getDueDateTerms() Gets the dur date query terms.
DateTimeRangeTerm[]	getOpenDateTerms() Gets the open date query terms.
PeriodQueryInspectorRecord	getPeriodQueryInspectorRecord(Type periodRecordType) Gets the period query inspector record corresponding to the given Period record Type.

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 labelquery terms

Compliance:

mandatory - This method must be implemented.

getOpenDateTerms

DateTimeRangeTerm[] getOpenDateTerms()

Gets the open date query terms.

Returns:

the open date query terms

Compliance:

mandatory - This method must be implemented.

getCloseDateTerms

DateTimeRangeTerm[] getCloseDateTerms()

Gets the close date query terms.

Returns:

the close date query terms

Compliance:

mandatory - This method must be implemented.

getBillingDateTerms

DateTimeRangeTerm[] getBillingDateTerms()

Gets the billing date query terms.

Returns:

the billing date query terms

Compliance:

mandatory - This method must be implemented.

getDueDateTerms

DateTimeRangeTerm[] getDueDateTerms()

Gets the dur date query terms.

Returns:

the dur date 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.

getPeriodQueryInspectorRecord

PeriodQueryInspectorRecord getPeriodQueryInspectorRecord(Type periodRecordType)
                                                         throws OperationFailedException

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

Parameters:

periodRecordType - a period record type

Returns:

the period query inspector record

Throws:

NullArgumentException - periodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(periodRecordType) is false

Compliance:

mandatory - This method must be implemented.