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

Modifier and Type	Method	Description
void	clearCourseCatalogIdTerms()	Clears the course catalog Id terms.
void	clearCourseCatalogTerms()	Clears the course catalog terms.
void	clearCourseRegistrationIdTerms()	Clears the course registration Id terms.
void	clearCourseRegistrationTerms()	Clears the course registration terms.
void	clearCreditsTerms()	Clears the credit terms.
void	clearGradingOptionIdTerms()	Clears the grade system Id terms.
void	clearGradingOptionTerms()	Clears the grading option terms.
void	clearRegistrationTargetIdTerms()	Clears the registration target Id terms.
void	clearRegistrationTargetTerms()	Clears the registration target terms.
void	clearStudentIdTerms()	Clears the student resource Id terms.
void	clearStudentTerms()	Clears the student resource terms.
CourseCatalogQuery	getCourseCatalogQuery()	Gets the query for a course catalog.
CourseRegistrationQuery	getCourseRegistrationQuery()	Gets the query for a course registration.
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 .
RegistrationTargetQuery	getRegistrationTargetQuery()	Gets the query for a registration target.
ResourceQuery	getStudentQuery()	Gets the query for a student.
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	matchCourseRegistrationId(Id courseRegistrationId, boolean match)	Sets the course registration Id for this query.
void	matchCredits(BigDecimal min, 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	matchRegistrationTargetId(Id registrationTargetId, boolean match)	Sets the registration target Id for this query.
void	matchStudentId(Id resourceId, boolean match)	Sets the student resource Id for this query.
boolean	supportsCourseCatalogQuery()	Tests if a CourseCatalogQuery is available.
boolean	supportsCourseRegistrationQuery()	Tests if a CourseRegistrationQuery is available.
boolean	supportsGradingOptionQuery()	Tests if a GradeSystemQuery is available.
boolean	supportsRegistrationTargetQuery()	Tests if a RegistrationTargetQuery is available.
boolean	supportsStudentQuery()	Tests if a ResourceQuery is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the end reason is available.

Methods inherited from interface OsidTemporalQuery

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

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

matchCourseRegistrationId

void matchCourseRegistrationId(Id courseRegistrationId,
 boolean match)

Sets the course registration Id for this query.

Parameters:

courseRegistrationId - a course registration Id

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

Throws:

NullArgumentException - courseRegistrationId is null

Compliance:

mandatory - This method must be implemented.

clearCourseRegistrationIdTerms

void clearCourseRegistrationIdTerms()

Clears the course registration Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCourseRegistrationQuery

boolean supportsCourseRegistrationQuery()

Tests if a CourseRegistrationQuery is available.

Returns:

true if a course registration query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseRegistrationQuery

CourseRegistrationQuery getCourseRegistrationQuery()

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

Returns:

the course registration query

Throws:

UnimplementedException - supportsCourseRegistrationQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCourseRegistrationQuery()} is {@code true} .

clearCourseRegistrationTerms

void clearCourseRegistrationTerms()

Clears the course registration terms.

Compliance:

mandatory - This method must be implemented.

matchRegistrationTargetId

void matchRegistrationTargetId(Id registrationTargetId,
 boolean match)

Sets the registration target Id for this query.

Parameters:

registrationTargetId - a registration target Id

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

Throws:

NullArgumentException - registrationTargetId is null

Compliance:

mandatory - This method must be implemented.

clearRegistrationTargetIdTerms

void clearRegistrationTargetIdTerms()

Clears the registration target Id terms.

Compliance:

mandatory - This method must be implemented.

supportsRegistrationTargetQuery

boolean supportsRegistrationTargetQuery()

Tests if a RegistrationTargetQuery is available.

Returns:

true if a registration target query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRegistrationTargetQuery

RegistrationTargetQuery getRegistrationTargetQuery()

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

Returns:

the registration target query

Throws:

UnimplementedException - supportsRegistrationTargetQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsRegistrationTargetQuery()} is {@code true} .

clearRegistrationTargetTerms

void clearRegistrationTargetTerms()

Clears the registration target 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 {@code supportsStudentQuery()} is {@code true} .

clearStudentTerms

void clearStudentTerms()

Clears the student resource terms.

Compliance:

mandatory - This method must be implemented.

matchCredits

void matchCredits(BigDecimal min,
 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 {@code supportsGradingOptionQuery()} is {@code 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 {@code supportsCourseCatalogQuery()} is {@code 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.