org.osid.course.registration

Interface RegistrationQuery

All Superinterfaces:

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

public interface RegistrationQuery
extends OsidRelationshipQuery

This is the query for searching 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	clearActivityBundleIdTerms() Clears the activity bundle Id terms.
void	clearActivityBundleTerms() Clears the activity bundle terms.
void	clearCourseCatalogIdTerms() Clears the course catalog Id terms.
void	clearCourseCatalogTerms() Clears the course catalog terms.
void	clearCreditsTerms() Clears the credit terms.
void	clearGradingOptionIdTerms() Clears the grade system Id terms.
void	clearGradingOptionTerms() Clears the grading option terms.
void	clearStudentIdTerms() Clears the student resource Id terms.
void	clearStudentTerms() Clears the student resource terms.
ActivityBundleQuery	getActivityBundleQuery() Gets the query for an activity bundle.
CourseCatalogQuery	getCourseCatalogQuery() Gets the query for a course catalog.
GradeSystemQuery	getGradingOptionQuery() Gets the query for a grading option.
RegistrationQueryRecord	getRegistrationQueryRecord(Type registrationRecordType) Gets the registration query record corresponding to the given Registration record Type.
ResourceQuery	getStudentQuery() Gets the query for a student.
void	matchActivityBundleId(Id activityBundleId, boolean match) Sets the activity bundle Id for this query to match registrations that have a related course.
void	matchAnyCredits(boolean match) Matches a registration that has any credits assigned.
void	matchAnyGradingOption(boolean match) Matches registrations that have any grading option.
void	matchCourseCatalogId(Id courseCatalogId, boolean match) Sets the course catalog Id for this query to match registrations assigned to course catalogs.
void	matchCredits(java.math.BigDecimal min, java.math.BigDecimal max, boolean match) Matches registrations with credits between the given numbers inclusive.
void	matchGradingOptionId(Id gradeSystemId, boolean match) Sets the grade system Id for this query.
void	matchStudentId(Id resourceId, boolean match) Sets the student resource Id for this query.
boolean	supportsActivityBundleQuery() Tests if an ActivityBundleQuery is available.
boolean	supportsCourseCatalogQuery() Tests if a CourseCatalogQuery is available.
boolean	supportsGradingOptionQuery() Tests if a GradeSystemQuery 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

matchActivityBundleId

void matchActivityBundleId(Id activityBundleId,
                         boolean match)

Sets the activity bundle Id for this query to match registrations that have a related course.

Parameters:

activityBundleId - an activity bundle Id

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

Throws:

NullArgumentException - activityBundleId is null

Compliance:

mandatory - This method must be implemented.

clearActivityBundleIdTerms

void clearActivityBundleIdTerms()

Clears the activity bundle Id terms.

Compliance:

mandatory - This method must be implemented.

supportsActivityBundleQuery

boolean supportsActivityBundleQuery()

Tests if an ActivityBundleQuery is available.

Returns:

true if an activity bundle query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getActivityBundleQuery

ActivityBundleQuery getActivityBundleQuery()

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

Returns:

the activity bundle query

Throws:

UnimplementedException - supportsActivityBundleQuery() is false

Compliance:

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

clearActivityBundleTerms

void clearActivityBundleTerms()

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

matchCredits

void matchCredits(java.math.BigDecimal min,
                java.math.BigDecimal max,
                boolean match)

Matches registrations with credits between the given numbers inclusive.

Parameters:

min - low number

max - high number

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

Throws:

InvalidArgumentException - max is less than min

Compliance:

mandatory - This method must be implemented.

matchAnyCredits

void matchAnyCredits(boolean match)

Matches a registration that has any credits assigned.

Parameters:

match - true to match registrations with any credits, false to match registrations with no credits

Compliance:

mandatory - This method must be implemented.

clearCreditsTerms

void clearCreditsTerms()

Clears the credit terms.

Compliance:

mandatory - This method must be implemented.

matchGradingOptionId

void matchGradingOptionId(Id gradeSystemId,
                        boolean match)

Sets the grade system Id for this query.

Parameters:

gradeSystemId - a grade system Id

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

Throws:

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearGradingOptionIdTerms

void clearGradingOptionIdTerms()

Clears the grade system Id terms.

Compliance:

mandatory - This method must be implemented.

supportsGradingOptionQuery

boolean supportsGradingOptionQuery()

Tests if a GradeSystemQuery is available.

Returns:

true if a grade system query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradingOptionQuery

GradeSystemQuery getGradingOptionQuery()

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

Returns:

a grade system query

Throws:

UnimplementedException - supportsGradingOptionQuery() is false

Compliance:

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

matchAnyGradingOption

void matchAnyGradingOption(boolean match)

Matches registrations that have any grading option.

Parameters:

match - true to match registrations with any grading option, false to match registrations with no grading options

Compliance:

mandatory - This method must be implemented.

clearGradingOptionTerms

void clearGradingOptionTerms()

Clears the grading option terms.

Compliance:

mandatory - This method must be implemented.

matchCourseCatalogId

void matchCourseCatalogId(Id courseCatalogId,
                        boolean match)

Sets the course catalog Id for this query to match registrations assigned to course catalogs.

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.

getRegistrationQueryRecord

RegistrationQueryRecord getRegistrationQueryRecord(Type registrationRecordType)
                                                   throws OperationFailedException

Gets the registration query 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 record

Throws:

NullArgumentException - registrationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationRecordType) is false

Compliance:

mandatory - This method must be implemented.