org.osid.course

Interface CourseOfferingQueryInspector

All Superinterfaces:

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

public interface CourseOfferingQueryInspector
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[]	getActivityIdTerms() Gets the activity Id query terms.
ActivityQueryInspector[]	getActivityTerms() Gets the activity query terms.
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.
CourseOfferingQueryInspectorRecord	getCourseOfferingQueryInspectorRecord(Type courseOfferingRecordType) Gets the course offering query inspector record corresponding to the given CourseOffering record Type.
CourseQueryInspector[]	getCourseTerms() Gets the course query terms.
IdTerm[]	getCreditAmountIdTerms() Gets the grade system Id query terms.
GradeQueryInspector[]	getCreditAmountTerms() Gets the grade system query terms.
IdTerm[]	getEventIdTerms() Gets the event Id query terms.
EventQueryInspector[]	getEventTerms() Gets the event query terms.
IdTerm[]	getGradingOptionIdTerms() Gets the grade system Id query terms.
GradeSystemQueryInspector[]	getGradingOptionTerms() Gets the grade system query terms.
IdTerm[]	getInstructorIdTerms() Gets the instructor Id query terms.
ResourceQueryInspector[]	getInstructorTerms() Gets the instructor 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.
BooleanTerm[]	getRequiresRegistrationTerms() Gets the requires registration query terms.
StringTerm[]	getScheduleInfoTerms() Gets the scheudle info 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

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 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 instructor Id query terms.

Returns:

the instructor Id query terms

Compliance:

mandatory - This method must be implemented.

getInstructorTerms

ResourceQueryInspector[] getInstructorTerms()

Gets the instructor query terms.

Returns:

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

getCreditAmountIdTerms

IdTerm[] getCreditAmountIdTerms()

Gets the grade system Id query terms.

Returns:

the grade system Id query terms

Compliance:

mandatory - This method must be implemented.

getCreditAmountTerms

GradeQueryInspector[] getCreditAmountTerms()

Gets the grade system query terms.

Returns:

the grade system query terms

Compliance:

mandatory - This method must be implemented.

getGradingOptionIdTerms

IdTerm[] getGradingOptionIdTerms()

Gets the grade system Id query terms.

Returns:

the grade system Id query terms

Compliance:

mandatory - This method must be implemented.

getGradingOptionTerms

GradeSystemQueryInspector[] getGradingOptionTerms()

Gets the grade system 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.

getScheduleInfoTerms

StringTerm[] getScheduleInfoTerms()

Gets the scheudle info query terms.

Returns:

the schedule info query terms

Compliance:

mandatory - This method must be implemented.

getEventIdTerms

IdTerm[] getEventIdTerms()

Gets the event Id query terms.

Returns:

the event Id query terms

Compliance:

mandatory - This method must be implemented.

getEventTerms

EventQueryInspector[] getEventTerms()

Gets the event query terms.

Returns:

the event terms

Compliance:

mandatory - This method must be implemented.

getActivityIdTerms

IdTerm[] getActivityIdTerms()

Gets the activity Id query terms.

Returns:

the activity Id query terms

Compliance:

mandatory - This method must be implemented.

getActivityTerms

ActivityQueryInspector[] getActivityTerms()

Gets the activity query terms.

Returns:

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

getCourseOfferingQueryInspectorRecord

CourseOfferingQueryInspectorRecord getCourseOfferingQueryInspectorRecord(Type courseOfferingRecordType)
                                                                         throws OperationFailedException

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

Parameters:

courseOfferingRecordType - a course offering record type

Returns:

the course offering query inspector record

Throws:

NullArgumentException - courseOfferingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseOfferingRecordType) is false

Compliance:

mandatory - This method must be implemented.