Interface RegistrationRequestItemQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSubjugateableQuery, Suppliable

public interface RegistrationRequestItemQuery
extends OsidObjectQuery, OsidSubjugateableQuery

This is the query for searching registration request items. 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 query terms.
void	clearCourseCatalogTerms()	Clears the course catalog query terms.
void	clearCreditOptionTerms()	Clears the credit option terms.
void	clearExistingRegistrationIdTerms()	Clears the existing registration Id query terms.
void	clearExistingRegistrationTerms()	Clears the existing registration query terms.
void	clearGradingOptionIdTerms()	Clears the grade system Id query terms.
void	clearGradingOptionTerms()	Clears the grading option query terms.
void	clearRegistrationRequestIdTerms()	Clears the registration request Id query terms.
void	clearRegistrationRequestTerms()	Clears the registration request query terms.
void	clearRegistrationTargetIdTerms()	Clears the registration target Id query terms.
void	clearRegistrationTargetTerms()	Clears the registration target query terms.
void	clearStudentIdTerms()	Clears the student resource Id query terms.
void	clearStudentTerms()	Clears the student query terms.
CourseCatalogQuery	getCourseCatalogQuery()	Gets the query for a course catalog.
RegistrationQuery	getExistingRegistrationQuery()	Gets the query for an existing registration .
GradeSystemQuery	getGradingOptionQuery()	Gets the query for a grade system.
RegistrationRequestItemQueryRecord	getRegistrationRequestItemQueryRecord(Type registrationRequestItemRecordType)	Gets the registration request item query record corresponding to the given RegistrationRequestItem record Type .
RegistrationRequestQuery	getRegistrationRequestQuery()	Gets the query for a registration request.
RegistrationTargetQuery	getRegistrationTargetQuery()	Gets the query for a registration target.
ResourceQuery	getStudentQuery()	Gets the query for a resource.
void	matchAnyCreditOption(boolean match)	Matches request items with any credit option.
void	matchAnyExistingRegistration(boolean match)	Matches request items with any existing registration.
void	matchAnyGradingOption(boolean match)	Matches request items with any grading option.
void	matchAnyRegistrationTarget(boolean match)	Matches request items with any registration target.
void	matchAnyStudent(boolean match)	Matches request items with any registration target.
void	matchCourseCatalogId(Id courseCatalogId, boolean match)	Sets the course catalog Id for this query to match registration request items assigned to course catalogs.
void	matchCreditOption(BigDecimal from, BigDecimal to, boolean match)	Matches request items with a credit option in the given range inclusive.
void	matchDropOperation(boolean match)	Matches request items for drops.
void	matchExistingRegistrationId(Id existingRegistrationId, boolean match)	Matches existing registrations.
void	matchGradingOptionId(Id gradeSystemId, boolean match)	Matches grading options.
void	matchRegisterOperation(boolean match)	Matches request items for registration.
void	matchRegistrationRequestId(Id registrationRequestId, boolean match)	Matches registration requests.
void	matchRegistrationTargetId(Id registrationTargetId, boolean match)	Matches registration targets.
void	matchStudentId(Id resourceId, boolean match)	Matches students.
void	matchUpdateOperation(boolean match)	Matches request items for updates.
boolean	supportsCourseCatalogQuery()	Tests if a CourseCatalogQuery is available.
boolean	supportsExistingTargetQuery()	Tests if a RegistrationQuery is available.
boolean	supportsGradingOptionQuery()	Tests if a GradeSystemQuery is available.
boolean	supportsRegistrationRequestQuery()	Tests if a RegistrationRequestQuery 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.

Method Details

matchRegistrationRequestId

void matchRegistrationRequestId(Id registrationRequestId,
 boolean match)

Matches registration requests.

Parameters:

registrationRequestId - the registration request Id

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

Throws:

NullArgumentException - registrationRequestId is null

Compliance:

mandatory - This method must be implemented.

clearRegistrationRequestIdTerms

void clearRegistrationRequestIdTerms()

Clears the registration request Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRegistrationRequestQuery

boolean supportsRegistrationRequestQuery()

Tests if a RegistrationRequestQuery is available.

Returns:

true if a registration request query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRegistrationRequestQuery

RegistrationRequestQuery getRegistrationRequestQuery()

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

Returns:

the registration request query

Throws:

UnimplementedException - supportsRegistrationRequestQuery() is false

Compliance:

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

clearRegistrationRequestTerms

void clearRegistrationRequestTerms()

Clears the registration request query terms.

Compliance:

mandatory - This method must be implemented.

matchStudentId

void matchStudentId(Id resourceId,
 boolean match)

Matches students.

Parameters:

resourceId - the resource Id

match - true for 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 query terms.

Compliance:

mandatory - This method must be implemented.

supportsStudentQuery

boolean supportsStudentQuery()

Tests if a ResourceQuery is available.

Returns:

true if a student resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStudentQuery

ResourceQuery getStudentQuery()

Gets the query for a resource. 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} .

matchAnyStudent

void matchAnyStudent(boolean match)

Matches request items with any registration target.

Parameters:

match - true to match request items with any student, false to match request items with no student

Compliance:

mandatory - This method must be implemented.

clearStudentTerms

void clearStudentTerms()

Clears the student query terms.

Compliance:

mandatory - This method must be implemented.

matchRegisterOperation

void matchRegisterOperation(boolean match)

Matches request items for registration.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

matchUpdateOperation

void matchUpdateOperation(boolean match)

Matches request items for updates.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

matchDropOperation

void matchDropOperation(boolean match)

Matches request items for drops.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

matchRegistrationTargetId

void matchRegistrationTargetId(Id registrationTargetId,
 boolean match)

Matches registration targets.

Parameters:

registrationTargetId - the registration target Id

match - true for 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 query 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} .

matchAnyRegistrationTarget

void matchAnyRegistrationTarget(boolean match)

Matches request items with any registration target.

Parameters:

match - true to match request items with any registration target, false to match request items with no registration targets

Compliance:

mandatory - This method must be implemented.

clearRegistrationTargetTerms

void clearRegistrationTargetTerms()

Clears the registration target query terms.

Compliance:

mandatory - This method must be implemented.

matchExistingRegistrationId

void matchExistingRegistrationId(Id existingRegistrationId,
 boolean match)

Matches existing registrations.

Parameters:

existingRegistrationId - the existing registration Id

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

Throws:

NullArgumentException - existingRegistrationId is null

Compliance:

mandatory - This method must be implemented.

clearExistingRegistrationIdTerms

void clearExistingRegistrationIdTerms()

Clears the existing registration Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsExistingTargetQuery

boolean supportsExistingTargetQuery()

Tests if a RegistrationQuery is available.

Returns:

true if an existing registration query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getExistingRegistrationQuery

RegistrationQuery getExistingRegistrationQuery()

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

Returns:

the registration query

Throws:

UnimplementedException - supportsExistingRegistrationQuery() is false

Compliance:

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

matchAnyExistingRegistration

void matchAnyExistingRegistration(boolean match)

Matches request items with any existing registration.

Parameters:

match - true to match request items with any existing registration, false to match request items with no existing registrations

Compliance:

mandatory - This method must be implemented.

clearExistingRegistrationTerms

void clearExistingRegistrationTerms()

Clears the existing registration query terms.

Compliance:

mandatory - This method must be implemented.

matchCreditOption

void matchCreditOption(BigDecimal from,
 BigDecimal to,
 boolean match)

Matches request items with a credit option in the given range inclusive.

Parameters:

from - start of range

to - end of range

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

Throws:

InvalidArgumentException - from is greater than to

Compliance:

mandatory - This method must be implemented.

matchAnyCreditOption

void matchAnyCreditOption(boolean match)

Matches request items with any credit option.

Parameters:

match - true to match request items with any existing credit option, false to match request items with no credit options

Compliance:

mandatory - This method must be implemented.

clearCreditOptionTerms

void clearCreditOptionTerms()

Clears the credit option terms.

Compliance:

mandatory - This method must be implemented.

matchGradingOptionId

void matchGradingOptionId(Id gradeSystemId,
 boolean match)

Matches grading options.

Parameters:

gradeSystemId - thegrade systemn Id

match - true for 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 query 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 grade system. Multiple retrievals produce a nested OR term.

Returns:

the 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 request items with any grading option.

Parameters:

match - true to match request items with any grading option, false to match request items with no grading option

Compliance:

mandatory - This method must be implemented.

clearGradingOptionTerms

void clearGradingOptionTerms()

Clears the grading option query 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 registration request items 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 query 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 query terms.

Compliance:

mandatory - This method must be implemented.

getRegistrationRequestItemQueryRecord

RegistrationRequestItemQueryRecord getRegistrationRequestItemQueryRecord(Type registrationRequestItemRecordType)
                                                                  throws OperationFailedException

Gets the registration request item query record corresponding to the given RegistrationRequestItem record Type . Multiple record retrievals produce a nested OR term.

Parameters:

registrationRequestItemRecordType - a registration request item record type

Returns:

the registration request item query record

Throws:

NullArgumentException - registrationRequestItemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationRequestItemRecordType) is false

Compliance:

mandatory - This method must be implemented.