org.osid.course.registration

Interface ActivityRegistrationQueryInspector

All Superinterfaces:

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

public interface ActivityRegistrationQueryInspector
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.
ActivityRegistrationQueryInspectorRecord	getActivityRegistrationQueryInspectorRecord(Type activityRegistrationRecordType) Gets the activity registration query inspector record corresponding to the given ActivityRegistration record Type.
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[]	getRegistrationIdTerms() Gets the registration Id query terms.
RegistrationQueryInspector[]	getRegistrationTerms() Gets the registration query terms.
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

getRegistrationIdTerms

IdTerm[] getRegistrationIdTerms()

Gets the registration Id query terms.

Returns:

the registration Id query terms

Compliance:

mandatory - This method must be implemented.

getRegistrationTerms

RegistrationQueryInspector[] getRegistrationTerms()

Gets the registration query terms.

Returns:

the registration query 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.

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.

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.

getActivityRegistrationQueryInspectorRecord

ActivityRegistrationQueryInspectorRecord getActivityRegistrationQueryInspectorRecord(Type activityRegistrationRecordType)
                                                                                     throws OperationFailedException

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

Parameters:

activityRegistrationRecordType - an activity registration record type

Returns:

the activity registration query inspector record

Throws:

NullArgumentException - activityRegistrationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityRegistrationRecordType) is false

Compliance:

mandatory - This method must be implemented.