org.osid.course.program

Interface ProgramQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector

public interface ProgramQueryInspector
extends OsidObjectQueryInspector, OsidOperableQueryInspector

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.
StringTerm[]	getNumberTerms() Gets the bumber query terms.
IdTerm[]	getProgramOfferingIdTerms() Gets the program offering Id query terms.
ProgramOfferingQueryInspector[]	getProgramOfferingTerms() Gets the program offering query terms.
ProgramQueryInspectorRecord	getProgramQueryInspectorRecord(Type programRecordType) Gets the program query inspector record corresponding to the given Program record Type.
IdTerm[]	getSponsorIdTerms() Gets the sponsor Id query terms.
ResourceQueryInspector[]	getSponsorTerms() Gets the sponsor query terms.
StringTerm[]	getTitleTerms() Gets the title 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

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Method Detail

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.

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.

getProgramOfferingIdTerms

IdTerm[] getProgramOfferingIdTerms()

Gets the program offering Id query terms.

Returns:

the program offering Id query terms

Compliance:

mandatory - This method must be implemented.

getProgramOfferingTerms

ProgramOfferingQueryInspector[] getProgramOfferingTerms()

Gets the program offering query terms.

Returns:

the program offering 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.

getProgramQueryInspectorRecord

ProgramQueryInspectorRecord getProgramQueryInspectorRecord(Type programRecordType)
                                                           throws OperationFailedException

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

Parameters:

programRecordType - a program record type

Returns:

the program query inspector record

Throws:

NullArgumentException - programRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programRecordType) is false

Compliance:

mandatory - This method must be implemented.