org.osid.course.registration

Interface ActivityRegistrationQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

public interface ActivityRegistrationQuery
extends OsidRelationshipQuery

This is the query for searching activity registrations. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearActivityIdTerms() Clears the activity Id terms.
void	clearActivityTerms() Clears the activity terms.
void	clearCourseCatalogIdTerms() Clears the course catalog Id terms.
void	clearCourseCatalogTerms() Clears the course catalog terms.
void	clearRegistrationIdTerms() Clears the registration Id terms.
void	clearRegistrationTerms() Clears the registration terms.
void	clearStudentIdTerms() Clears the student resource Id terms.
void	clearStudentTerms() Clears the student resource terms.
ActivityQuery	getActivityQuery() Gets the query for an activity.
ActivityRegistrationQueryRecord	getActivityRegistrationQueryRecord(Type activityRegistrationRecordType) Gets the activity registration query record corresponding to the given Course record Type.
CourseCatalogQuery	getCourseCatalogQuery() Gets the query for a course catalog.
RegistrationQuery	getRegistrationQuery() Gets the query for a registration.
ResourceQuery	getStudentQuery() Gets the query for a student.
void	matchActivityId(Id activityId, boolean match) Sets the activity Id for this query.
void	matchCourseCatalogId(Id courseCatalogId, boolean match) Sets the course catalog Id for this query.
void	matchRegistrationId(Id registrationId, boolean match) Sets the registration Id for this query.
void	matchStudentId(Id resourceId, boolean match) Sets the student resource Id for this query.
boolean	supportsActivityQuery() Tests if an ActivityQuery is available.
boolean	supportsCourseCatalogQuery() Tests if a CourseCatalogQuery is available.
boolean	supportsRegistrationQuery() Tests if a RegistrationQuery is available.
boolean	supportsStudentQuery() Tests if a ResourceQuery is available.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchRegistrationId

void matchRegistrationId(Id registrationId,
                       boolean match)

Sets the registration Id for this query.

Parameters:

registrationId - a registration Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - registrationId is null

Compliance:

mandatory - This method must be implemented.

clearRegistrationIdTerms

void clearRegistrationIdTerms()

Clears the registration Id terms.

Compliance:

mandatory - This method must be implemented.

supportsRegistrationQuery

boolean supportsRegistrationQuery()

Tests if a RegistrationQuery is available.

Returns:

true if a registration query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRegistrationQuery

RegistrationQuery getRegistrationQuery()

Gets the query for a registration. Multiple retrievals produce a nested OR term.

Returns:

the registration query

Throws:

UnimplementedException - supportsRegistrationQuery() is false

Compliance:

optional - This method must be implemented if supportsRegistrationQuery() is true.

clearRegistrationTerms

void clearRegistrationTerms()

Clears the registration terms.

Compliance:

mandatory - This method must be implemented.

matchActivityId

void matchActivityId(Id activityId,
                   boolean match)

Sets the activity Id for this query.

Parameters:

activityId - an activity Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - activityId is null

Compliance:

mandatory - This method must be implemented.

clearActivityIdTerms

void clearActivityIdTerms()

Clears the activity Id terms.

Compliance:

mandatory - This method must be implemented.

supportsActivityQuery

boolean supportsActivityQuery()

Tests if an ActivityQuery is available.

Returns:

true if an activity query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActivityQuery

ActivityQuery getActivityQuery()

Gets the query for an activity. Multiple retrievals produce a nested OR term.

Returns:

the activity query

Throws:

UnimplementedException - supportsActivityQuery() is false

Compliance:

optional - This method must be implemented if supportsActivityQuery() is true.

clearActivityTerms

void clearActivityTerms()

Clears the activity terms.

Compliance:

mandatory - This method must be implemented.

matchStudentId

void matchStudentId(Id resourceId,
                  boolean match)

Sets the student resource Id for this query.

Parameters:

resourceId - a resource Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearStudentIdTerms

void clearStudentIdTerms()

Clears the student resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsStudentQuery

boolean supportsStudentQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStudentQuery

ResourceQuery getStudentQuery()

Gets the query for a student. Multiple retrievals produce a nested OR term.

Returns:

the resource query

Throws:

UnimplementedException - supportsStudentQuery() is false

Compliance:

optional - This method must be implemented if supportsStudentQuery() is true.

clearStudentTerms

void clearStudentTerms()

Clears the student resource terms.

Compliance:

mandatory - This method must be implemented.

matchCourseCatalogId

void matchCourseCatalogId(Id courseCatalogId,
                        boolean match)

Sets the course catalog Id for this query.

Parameters:

courseCatalogId - the course catalog Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - courseCatalogId is null

Compliance:

mandatory - This method must be implemented.

clearCourseCatalogIdTerms

void clearCourseCatalogIdTerms()

Clears the course catalog Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCourseCatalogQuery

boolean supportsCourseCatalogQuery()

Tests if a CourseCatalogQuery is available.

Returns:

true if a course catalog query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseCatalogQuery

CourseCatalogQuery getCourseCatalogQuery()

Gets the query for a course catalog. Multiple retrievals produce a nested OR term.

Returns:

the course catalog query

Throws:

UnimplementedException - supportsCourseCatalogQuery() is false

Compliance:

optional - This method must be implemented if supportsCourseCatalogQuery() is true.

clearCourseCatalogTerms

void clearCourseCatalogTerms()

Clears the course catalog terms.

Compliance:

mandatory - This method must be implemented.

getActivityRegistrationQueryRecord

ActivityRegistrationQueryRecord getActivityRegistrationQueryRecord(Type activityRegistrationRecordType)
                                                                   throws OperationFailedException

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

Parameters:

activityRegistrationRecordType - an activity registration record type

Returns:

the activity registration query record

Throws:

NullArgumentException - activityRegistrationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityRegistrationRecordType) is false

Compliance:

mandatory - This method must be implemented.