org.osid.course.registration

Interface RegistrationQueryInspector

All Superinterfaces:

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

public interface RegistrationQueryInspector
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[]	getActivityBundleIdTerms() Gets the activity bundle Id query terms.
ActivityBundleQueryInspector[]	getActivityBundleTerms() Gets the activity bundle query terms.
IdTerm[]	getCourseCatalogIdTerms() Gets the course catalog Id query terms.
CourseCatalogQueryInspector[]	getCourseCatalogTerms() Gets the course catalog query terms.
DecimalTerm[]	getCreditsTerms() Gets the credits query terms.
IdTerm[]	getGradingOptionIdTerms() Gets the grade system Id query terms.
GradeSystemQueryInspector[]	getGradingOptionTerms() Gets the grade system query terms.
RegistrationQueryInspectorRecord	getRegistrationQueryInspectorRecord(Type registrationRecordType) Gets the registration query inspector record corresponding to the given Registration record Type.
IdTerm[]	getStudentIdTerms() Gets the student Id query terms.
ResourceQueryInspector[]	getStudentTerms() Gets the student 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

getActivityBundleIdTerms

IdTerm[] getActivityBundleIdTerms()

Gets the activity bundle Id query terms.

Returns:

the activity bundle Id query terms

Compliance:

mandatory - This method must be implemented.

getActivityBundleTerms

ActivityBundleQueryInspector[] getActivityBundleTerms()

Gets the activity bundle query terms.

Returns:

the activity bundle query terms

Compliance:

mandatory - This method must be implemented.

getStudentIdTerms

IdTerm[] getStudentIdTerms()

Gets the student Id query terms.

Returns:

the student Id query terms

Compliance:

mandatory - This method must be implemented.

getStudentTerms

ResourceQueryInspector[] getStudentTerms()

Gets the student query terms.

Returns:

the student query terms

Compliance:

mandatory - This method must be implemented.

getCreditsTerms

DecimalTerm[] getCreditsTerms()

Gets the credits query terms.

Returns:

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

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.

getRegistrationQueryInspectorRecord

RegistrationQueryInspectorRecord getRegistrationQueryInspectorRecord(Type registrationRecordType)
                                                                     throws OperationFailedException

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

Parameters:

registrationRecordType - a registration record type

Returns:

the registration query inspector record

Throws:

NullArgumentException - registrationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationRecordType) is false

Compliance:

mandatory - This method must be implemented.