public interface CourseEntryQuery extends OsidRelationshipQuery
This is the query for searching course entries. 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 |
clearCompleteTerms()
Clears the complete terms.
|
void |
clearCourseCatalogIdTerms()
Clears the course catalog
Id terms. |
void |
clearCourseCatalogTerms()
Clears the course catalog terms.
|
void |
clearCourseIdTerms()
Clears the course
Id terms. |
void |
clearCourseTerms()
Clears the course terms.
|
void |
clearCreditScaleIdTerms()
Clears the grade system
Id terms. |
void |
clearCreditScaleTerms()
Clears the credit scale terms.
|
void |
clearCreditsEarnedTerms()
Clears the earned credits terms.
|
void |
clearGradeIdTerms()
Clears the grade
Id terms. |
void |
clearGradeTerms()
Clears the grade terms.
|
void |
clearRegistrationIdTerms()
Clears the registration
Id terms. |
void |
clearRegistrationTerms()
Clears the registration terms.
|
void |
clearScoreScaleIdTerms()
Clears the grade system
Id terms. |
void |
clearScoreScaleTerms()
Clears the score scale terms.
|
void |
clearScoreTerms()
Clears the score terms.
|
void |
clearStudentIdTerms()
Clears the student
Id terms. |
void |
clearStudentTerms()
Clears the student option terms.
|
void |
clearTermIdTerms()
Clears the term
Id terms. |
void |
clearTermTerms()
Clears the term terms.
|
CourseCatalogQuery |
getCourseCatalogQuery()
Gets the query for a course catalog.
|
CourseEntryQueryRecord |
getCourseEntryQueryRecord(Type courseEntryRecordType)
Gets the course entry query record corresponding to the given
CourseEntry record Type. |
CourseQuery |
getCourseQuery()
Gets the query for a course entry.
|
GradeSystemQuery |
getCreditScaleQuery()
Gets the query for a grade system.
|
GradeQuery |
getGradeQuery()
Gets the query for a grade.
|
RegistrationQuery |
getRegistrationQuery()
Gets the query for a registration entry.
|
GradeSystemQuery |
getScoreScaleQuery()
Gets the query for a grade system.
|
ResourceQuery |
getStudentQuery()
Gets the query for a student option.
|
TermQuery |
getTermQuery()
Gets the query for a term entry.
|
void |
matchAnyCreditScale(boolean match)
Matches entries that have any credit scale.
|
void |
matchAnyCreditsEarned(boolean match)
Matches entries that have any earned credits.
|
void |
matchAnyGrade(boolean match)
Matches entries that have any grade.
|
void |
matchAnyRegistration(boolean match)
Matches entries that have any registration.
|
void |
matchAnyScore(boolean match)
Matches entries that have any score.
|
void |
matchAnyScoreScale(boolean match)
Matches entries that have any score scale.
|
void |
matchComplete(boolean match)
Matches completed courses.
|
void |
matchCourseCatalogId(Id courseCatalogId,
boolean match)
Sets the course catalog
Id for this query to match
entries assigned to course catalogs. |
void |
matchCourseId(Id courseId,
boolean match)
Sets the course
Id for this query to match entries that
have an entry for the given course. |
void |
matchCreditScaleId(Id gradeSystemId,
boolean match)
Matches a credit scale
Id. |
void |
matchCreditsEarned(java.math.BigDecimal from,
java.math.BigDecimal to,
boolean match)
Matches earned credits between the given range inclusive.
|
void |
matchGradeId(Id gradeId,
boolean match)
Matches a grade
Id. |
void |
matchRegistrationId(Id enrollmentId,
boolean match)
Sets the enrollment
Id for this query. |
void |
matchScore(java.math.BigDecimal from,
java.math.BigDecimal to,
boolean match)
Matches scores between the given range inclusive.
|
void |
matchScoreScaleId(Id gradeSystemId,
boolean match)
Matches a score scale
Id. |
void |
matchStudentId(Id resourceId,
boolean match)
Sets the student
Id for this query. |
void |
matchTermId(Id termId,
boolean match)
Sets the term
Id for this query. |
boolean |
supportsCourseCatalogQuery()
Tests if a
CourseCatalogQuery is available. |
boolean |
supportsCourseQuery()
Tests if a
CourseQuery is available. |
boolean |
supportsCreditScaleQuery()
Tests if a
GradeSystemQuery is available. |
boolean |
supportsGradeQuery()
Tests if a
GradeQuery is available. |
boolean |
supportsRegistrationQuery()
Tests if a
RegistrationQuery is available. |
boolean |
supportsScoreScaleQuery()
Tests if a
GradeSystemQuery is available. |
boolean |
supportsStudentQuery()
Tests if a
StudentQuery is available. |
boolean |
supportsTermQuery()
Tests if a
TermQuery 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 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()
StudentQuery
is available. true
if a student 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 matchCourseId(Id courseId, boolean match)
Id
for this query to match entries that
have an entry for the given course.courseId
- a course Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- courseId
is
null
mandatory
- This method must be implemented. void clearCourseIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCourseQuery()
CourseQuery
is available. true
if a course query is available,
false
otherwisemandatory
- This method must be implemented. CourseQuery getCourseQuery()
OR
term.UnimplementedException
- supportsCourseQuery()
is false
optional
- This method must be implemented if
supportsCourseQuery()
is true.
void clearCourseTerms()
mandatory
- This method must be implemented. void matchTermId(Id termId, boolean match)
Id
for this query.termId
- a term Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- termId
is
null
mandatory
- This method must be implemented. void clearTermIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsTermQuery()
TermQuery
is available. true
if a term query is available, false
otherwisemandatory
- This method must be implemented. TermQuery getTermQuery()
OR
term.UnimplementedException
- supportsTermQuery()
is false
optional
- This method must be implemented if
supportsTermQuery()
is true.
void clearTermTerms()
mandatory
- This method must be implemented. void matchComplete(boolean match)
match
- true
if a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearCompleteTerms()
mandatory
- This method must be implemented. void matchCreditScaleId(Id gradeSystemId, boolean match)
Id.
gradeSystemId
- a grade system Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- gradeSystemId
is
null
mandatory
- This method must be implemented. void clearCreditScaleIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCreditScaleQuery()
GradeSystemQuery
is available. true
if a grade system query is available,
false
otherwisemandatory
- This method must be implemented. GradeSystemQuery getCreditScaleQuery()
OR
term.UnimplementedException
-
supportsCreditScaleQuery()
is false
optional
- This method must be implemented if
supportsCreditScaleQuery()
is true.
void matchAnyCreditScale(boolean match)
match
- true
to match entries with any credit
scale, false
to match entries with no credit
scalemandatory
- This method must be implemented. void clearCreditScaleTerms()
mandatory
- This method must be implemented. void matchCreditsEarned(java.math.BigDecimal from, java.math.BigDecimal to, boolean match)
from
- starting valueto
- ending valuematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyCreditsEarned(boolean match)
match
- true
to match entries with any earned
credits, false
to match entries with no earned
creditsmandatory
- This method must be implemented. void clearCreditsEarnedTerms()
mandatory
- This method must be implemented. void matchGradeId(Id gradeId, boolean match)
Id.
gradeId
- a grade Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- gradeId
is
null
mandatory
- This method must be implemented. void clearGradeIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsGradeQuery()
GradeQuery
is available. true
if a grade query is available,
false
otherwisemandatory
- This method must be implemented. GradeQuery getGradeQuery()
OR
term.UnimplementedException
- supportsGradeQuery()
is false
optional
- This method must be implemented if
supportsGradeQuery()
is true.
void matchAnyGrade(boolean match)
match
- true
to match entries with any grade,
false
to match entries with no grademandatory
- This method must be implemented. void clearGradeTerms()
mandatory
- This method must be implemented. void matchScoreScaleId(Id gradeSystemId, boolean match)
Id.
gradeSystemId
- a grade system Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- gradeSystemId
is
null
mandatory
- This method must be implemented. void clearScoreScaleIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsScoreScaleQuery()
GradeSystemQuery
is available. true
if a grade system query is available,
false
otherwisemandatory
- This method must be implemented. GradeSystemQuery getScoreScaleQuery()
OR
term.UnimplementedException
-
supportsScoreScaleQuery()
is false
optional
- This method must be implemented if
supportsScoreScaleQuery()
is true.
void matchAnyScoreScale(boolean match)
match
- true
to match entries with any score
scale, false
to match entries with no score
scalemandatory
- This method must be implemented. void clearScoreScaleTerms()
mandatory
- This method must be implemented. void matchScore(java.math.BigDecimal from, java.math.BigDecimal to, boolean match)
from
- starting valueto
- ending valuematch
- true
if a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyScore(boolean match)
match
- true
to match entries with any score,
false
to match entries with no scoremandatory
- This method must be implemented. void clearScoreTerms()
mandatory
- This method must be implemented. void matchRegistrationId(Id enrollmentId, boolean match)
Id
for this query.enrollmentId
- an enrollment Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- enrollmentId
is
null
mandatory
- This method must be implemented. void clearRegistrationIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsRegistrationQuery()
RegistrationQuery
is available. true
if a registration query is available,
false
otherwisemandatory
- This method must be implemented. RegistrationQuery getRegistrationQuery()
OR
term.UnimplementedException
-
supportsRegistrationQuery()
is false
optional
- This method must be implemented if
supportsRegistrationQuery()
is true.
void matchAnyRegistration(boolean match)
match
- true
to match enries with any
registration, false
to match enries with no
registrationmandatory
- This method must be implemented. void clearRegistrationTerms()
mandatory
- This method must be implemented. void matchCourseCatalogId(Id courseCatalogId, boolean match)
Id
for this query to match
entries assigned to course catalogs.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. CourseEntryQueryRecord getCourseEntryQueryRecord(Type courseEntryRecordType) throws OperationFailedException
CourseEntry
record Type.
Multiple record
retrievals produce a nested OR
term.courseEntryRecordType
- a course entry record typeNullArgumentException
- courseEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(courseEntryRecordType)
is false
mandatory
- This method must be implemented.