org.osid.course.requisite

Interface RequisiteQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidContainableQueryInspector, OsidEnablerQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector, OsidTemporalQueryInspector

public interface RequisiteQueryInspector
extends OsidRuleQueryInspector, OsidEnablerQueryInspector, OsidContainableQueryInspector

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[]	getAssessmentIdTerms() Gets the assessment Id query terms.
AssessmentQueryInspector[]	getAssessmentTerms() Gets the assessment query terms.
IdTerm[]	getAwardIdTerms() Gets the award Id query terms.
AwardQueryInspector[]	getAwardTerms() Gets the award query terms.
IdTerm[]	getContainingRequisiteIdTerms() Gets the containing This method must be implemented.
RequisiteQueryInspector[]	getContainingRequisiteTerms() Gets the containing This method must be implemented.
IdTerm[]	getCourseCatalogIdTerms() Gets the course catalog Id query terms.
CourseCatalogQueryInspector[]	getCourseCatalogTerms() Gets the course catalog query terms.
IdTerm[]	getCourseIdTerms() Gets the course Id query terms.
CourseQueryInspector[]	getCourseTerms() Gets the course query terms.
IdTerm[]	getCredentialIdTerms() Gets the credential Id query terms.
CredentialQueryInspector[]	getCredentialTerms() Gets the credential query terms.
IdTerm[]	getLearningObjectiveIdTerms() Gets the learning objective Id query terms.
ObjectiveQueryInspector[]	getLearningObjectiveTerms() Gets the learning objective query terms.
IdTerm[]	getProgramIdTerms() Gets the program Id query terms.
ProgramQueryInspector[]	getProgramTerms() Gets the program query terms.
IdTerm[]	getRequisiteOptionIdTerms() Gets the requisite option Id query terms.
RequisiteQueryInspector[]	getRequisiteOptionTerms() Gets the requisite option query terms.
RequisiteQueryInspectorRecord	getRequisiteQueryInspectorRecord(Type requisiteRecordType) Gets the requisite query inspector record corresponding to the given Requisite record Type.

Methods inherited from interface org.osid.OsidEnablerQueryInspector

getCyclicEventIdTerms, getCyclicEventTerms, getDemographicIdTerms, getDemographicTerms, getEventIdTerms, getEventTerms, getScheduleIdTerms, getScheduleTerms

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

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

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Methods inherited from interface org.osid.OsidContainableQueryInspector

getSequesteredTerms

Method Detail

getRequisiteOptionIdTerms

IdTerm[] getRequisiteOptionIdTerms()

Gets the requisite option Id query terms.

Returns:

the requisite Id query terms

Compliance:

mandatory - This method must be implemented.

getRequisiteOptionTerms

RequisiteQueryInspector[] getRequisiteOptionTerms()

Gets the requisite option query terms.

Returns:

the requisite query terms

Compliance:

mandatory - This method must be implemented.

getCourseIdTerms

IdTerm[] getCourseIdTerms()

Gets the course Id query terms.

Returns:

the course Id query terms

Compliance:

mandatory - This method must be implemented.

getCourseTerms

CourseQueryInspector[] getCourseTerms()

Gets the course query terms.

Returns:

the course terms

Compliance:

mandatory - This method must be implemented.

getProgramIdTerms

IdTerm[] getProgramIdTerms()

Gets the program Id query terms.

Returns:

the program Id query terms

Compliance:

mandatory - This method must be implemented.

getProgramTerms

ProgramQueryInspector[] getProgramTerms()

Gets the program query terms.

Returns:

the program terms

Compliance:

mandatory - This method must be implemented.

getCredentialIdTerms

IdTerm[] getCredentialIdTerms()

Gets the credential Id query terms.

Returns:

the credential Id query terms

Compliance:

mandatory - This method must be implemented.

getCredentialTerms

CredentialQueryInspector[] getCredentialTerms()

Gets the credential query terms.

Returns:

the credential terms

Compliance:

mandatory - This method must be implemented.

getLearningObjectiveIdTerms

IdTerm[] getLearningObjectiveIdTerms()

Gets the learning objective Id query terms.

Returns:

the learning objective Id query terms

Compliance:

mandatory - This method must be implemented.

getLearningObjectiveTerms

ObjectiveQueryInspector[] getLearningObjectiveTerms()

Gets the learning objective query terms.

Returns:

the learning objective terms

Compliance:

mandatory - This method must be implemented.

getAssessmentIdTerms

IdTerm[] getAssessmentIdTerms()

Gets the assessment Id query terms.

Returns:

the assessment Id query terms

Compliance:

mandatory - This method must be implemented.

getAssessmentTerms

AssessmentQueryInspector[] getAssessmentTerms()

Gets the assessment query terms.

Returns:

the assessment terms

Compliance:

mandatory - This method must be implemented.

getAwardIdTerms

IdTerm[] getAwardIdTerms()

Gets the award Id query terms.

Returns:

the award Id query terms

Compliance:

mandatory - This method must be implemented.

getAwardTerms

AwardQueryInspector[] getAwardTerms()

Gets the award query terms.

Returns:

the award terms

Compliance:

mandatory - This method must be implemented.

getContainingRequisiteIdTerms

IdTerm[] getContainingRequisiteIdTerms()

Gets the containing This method must be implemented. Id terms.

Returns:

the This method must be implemented. Id terms

Compliance:

mandatory - This method must be implemented.

getContainingRequisiteTerms

RequisiteQueryInspector[] getContainingRequisiteTerms()

Gets the containing This method must be implemented. terms.

Returns:

the requisite 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.

getRequisiteQueryInspectorRecord

RequisiteQueryInspectorRecord getRequisiteQueryInspectorRecord(Type requisiteRecordType)
                                                               throws OperationFailedException

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

Parameters:

requisiteRecordType - a requisite record type

Returns:

the requisite query inspector record

Throws:

NullArgumentException - requisiteRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requisiteRecordType) is false

Compliance:

mandatory - This method must be implemented.