public interface EnrollmentQuery extends OsidRelationshipQuery
This is the query for searching enrollments. Each method match
specifies an AND
term while multiple invocations of the
same method produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearCourseCatalogIdTerms()
Clears the course catalog
Id terms. |
void |
clearCourseCatalogTerms()
Clears the course catalog terms.
|
void |
clearProgramOfferingIdTerms()
Clears the program offering
Id terms. |
void |
clearProgramOfferingTerms()
Clears the program offering 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.
|
EnrollmentQueryRecord |
getEnrollmentQueryRecord(Type enrollmentRecordType)
Gets the enrollment query record corresponding to the given
Course record Type. |
ProgramOfferingQuery |
getProgramOfferingQuery()
Gets the query for a program offering.
|
ResourceQuery |
getStudentQuery()
Gets the query for a student.
|
void |
matchCourseCatalogId(Id courseCatalogId,
boolean match)
Sets the course catalog
Id for this query. |
void |
matchProgramOfferingId(Id programOfferingId,
boolean match)
Sets the program offering
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 |
supportsProgramOfferingQuery()
Tests if a
ProgramOffering is available. |
boolean |
supportsStudentQuery()
Tests if a
ResourceQuery is available. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchProgramOfferingId(Id programOfferingId, boolean match)
Id
for this query.programOfferingId
- a program offering Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- programOfferingId
is null
mandatory
- This method must be implemented. void clearProgramOfferingIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsProgramOfferingQuery()
ProgramOffering
is available. true
if a program offering query is available,
false
otherwisemandatory
- This method must be implemented. ProgramOfferingQuery getProgramOfferingQuery()
OR
term.UnimplementedException
-
supportsProgramOfferingQuery()
is false
optional
- This method must be implemented if
supportsProgramOfferingQuery()
is true.
void clearProgramOfferingTerms()
mandatory
- This method must be implemented. void matchStudentId(Id resourceId, boolean match)
Id
for this query.resourceId
- a resource Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearStudentIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsStudentQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getStudentQuery()
OR
term.UnimplementedException
- supportsStudentQuery()
is false
optional
- This method must be implemented if
supportsStudentQuery()
is true.
void clearStudentTerms()
mandatory
- This method must be implemented. void matchCourseCatalogId(Id courseCatalogId, boolean match)
Id
for this query.courseCatalogId
- the course catalog Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- courseCatalogId
is null
mandatory
- This method must be implemented. void clearCourseCatalogIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCourseCatalogQuery()
CourseCatalogQuery
is available. true
if a course catalog query is available,
false
otherwisemandatory
- This method must be implemented. CourseCatalogQuery getCourseCatalogQuery()
OR
term.UnimplementedException
-
supportsCourseCatalogQuery()
is false
optional
- This method must be implemented if
supportsCourseCatalogQuery()
is true.
void clearCourseCatalogTerms()
mandatory
- This method must be implemented. EnrollmentQueryRecord getEnrollmentQueryRecord(Type enrollmentRecordType) throws OperationFailedException
Course
record Type.
Multiple record retrievals
produce a nested OR
term.enrollmentRecordType
- an enrollment record typeNullArgumentException
- enrollmentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(enrollmentRecordType)
is false
mandatory
- This method must be implemented.