org.osid.course.program

Interface ProgramOfferingQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface ProgramOfferingQueryInspector
extends OsidRelationshipQueryInspector

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
IdTerm[]	getCompletionRequirementsIdTerms() Gets the completion requirements requisite Id query terms.
StringTerm[]	getCompletionRequirementsInfoTerms() Gets the completion requirements query terms.
RequisiteQueryInspector[]	getCompletionRequirementsTerms() Gets the completion requirements requisite query terms.
IdTerm[]	getCourseCatalogIdTerms() Gets the course catalog Id query terms.
CourseCatalogQueryInspector[]	getCourseCatalogTerms() Gets the course catalog query terms.
IdTerm[]	getCredentialIdTerms() Gets the credential Id query terms.
CredentialQueryInspector[]	getCredentialTerms() Gets the credential query terms.
IdTerm[]	getInstructorIdTerms() Gets the sponsor Id query terms.
ResourceQueryInspector[]	getInstructorTerms() Gets the sponsor query terms.
CardinalRangeTerm[]	getMaximumSeatsTerms() Gets the maximum seats query terms.
CardinalRangeTerm[]	getMinimumSeatsTerms() Gets the minimum seats query terms.
StringTerm[]	getNumberTerms() Gets the bumber query terms.
IdTerm[]	getProgramIdTerms() Gets the course Id query terms.
ProgramOfferingQueryInspectorRecord	getProgramOfferingQueryInspectorRecord(Type programOfferingRecordType) Gets the program offering query inspector record corresponding to the given ProgramOffering record Type.
ProgramQueryInspector[]	getProgramTerms() Gets the program query terms.
BooleanTerm[]	getRequiresRegistrationTerms() Gets the requires registration query terms.
IdTerm[]	getSponsorIdTerms() Gets the sponsor Id query terms.
ResourceQueryInspector[]	getSponsorTerms() Gets the sponsor query terms.
IdTerm[]	getTermIdTerms() Gets the term Id query terms.
TermQueryInspector[]	getTermTerms() Gets the term query terms.
StringTerm[]	getTitleTerms() Gets the title query terms.
StringTerm[]	getURLTerms() Gets the url query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getProgramIdTerms

IdTerm[] getProgramIdTerms()

Gets the course Id query terms.

Returns:

the course Id query terms

Compliance:

mandatory - This method must be implemented.

getProgramTerms

ProgramQueryInspector[] getProgramTerms()

Gets the program query terms.

Returns:

the program query terms

Compliance:

mandatory - This method must be implemented.

getTermIdTerms

IdTerm[] getTermIdTerms()

Gets the term Id query terms.

Returns:

the term Id query terms

Compliance:

mandatory - This method must be implemented.

getTermTerms

TermQueryInspector[] getTermTerms()

Gets the term query terms.

Returns:

the term query terms

Compliance:

mandatory - This method must be implemented.

getTitleTerms

StringTerm[] getTitleTerms()

Gets the title query terms.

Returns:

the title query terms

Compliance:

mandatory - This method must be implemented.

getNumberTerms

StringTerm[] getNumberTerms()

Gets the bumber query terms.

Returns:

the number query terms

Compliance:

mandatory - This method must be implemented.

getInstructorIdTerms

IdTerm[] getInstructorIdTerms()

Gets the sponsor Id query terms.

Returns:

the sponsor Id query terms

Compliance:

mandatory - This method must be implemented.

getInstructorTerms

ResourceQueryInspector[] getInstructorTerms()

Gets the sponsor query terms.

Returns:

the sponsor query terms

Compliance:

mandatory - This method must be implemented.

getSponsorIdTerms

IdTerm[] getSponsorIdTerms()

Gets the sponsor Id query terms.

Returns:

the sponsor Id query terms

Compliance:

mandatory - This method must be implemented.

getSponsorTerms

ResourceQueryInspector[] getSponsorTerms()

Gets the sponsor query terms.

Returns:

the sponsor query terms

Compliance:

mandatory - This method must be implemented.

getCompletionRequirementsInfoTerms

StringTerm[] getCompletionRequirementsInfoTerms()

Gets the completion requirements query terms.

Returns:

the prereq query terms

Compliance:

mandatory - This method must be implemented.

getCompletionRequirementsIdTerms

IdTerm[] getCompletionRequirementsIdTerms()

Gets the completion requirements requisite Id query terms.

Returns:

the requisite Id query terms

Compliance:

mandatory - This method must be implemented.

getCompletionRequirementsTerms

RequisiteQueryInspector[] getCompletionRequirementsTerms()

Gets the completion requirements requisite query terms.

Returns:

the requisite query terms

Compliance:

mandatory - This method must be implemented.

getCredentialIdTerms

IdTerm[] getCredentialIdTerms()

Gets the credential Id query terms.

Returns:

the grade system Id query terms

Compliance:

mandatory - This method must be implemented.

getCredentialTerms

CredentialQueryInspector[] getCredentialTerms()

Gets the credential query terms.

Returns:

the grade system terms

Compliance:

mandatory - This method must be implemented.

getRequiresRegistrationTerms

BooleanTerm[] getRequiresRegistrationTerms()

Gets the requires registration query terms.

Returns:

the requires registration query terms

Compliance:

mandatory - This method must be implemented.

getMinimumSeatsTerms

CardinalRangeTerm[] getMinimumSeatsTerms()

Gets the minimum seats query terms.

Returns:

the minimum seats query terms

Compliance:

mandatory - This method must be implemented.

getMaximumSeatsTerms

CardinalRangeTerm[] getMaximumSeatsTerms()

Gets the maximum seats query terms.

Returns:

the maximum seats query terms

Compliance:

mandatory - This method must be implemented.

getURLTerms

StringTerm[] getURLTerms()

Gets the url query terms.

Returns:

the url query terms

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdTerms

IdTerm[] getCourseCatalogIdTerms()

Gets the course catalog Id query terms.

Returns:

the course catalog Id query terms

Compliance:

mandatory - This method must be implemented.

getCourseCatalogTerms

CourseCatalogQueryInspector[] getCourseCatalogTerms()

Gets the course catalog query terms.

Returns:

the course catalog query terms

Compliance:

mandatory - This method must be implemented.

getProgramOfferingQueryInspectorRecord

ProgramOfferingQueryInspectorRecord getProgramOfferingQueryInspectorRecord(Type programOfferingRecordType)
                                                                           throws OperationFailedException

Gets the program offering query inspector record corresponding to the given ProgramOffering record Type. Multiple record retrievals produce a nested OR term.

Parameters:

programOfferingRecordType - a program offering record type

Returns:

the program offering query inspector record

Throws:

NullArgumentException - programOfferingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programOfferingRecordType) is false

Compliance:

mandatory - This method must be implemented.