public interface AwardEntryQuery extends OsidRelationshipQuery
This is the query for searching award 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 |
clearAssessmentIdTerms()
Clears the assessment
Id terms. |
void |
clearAssessmentTerms()
Clears the assessment terms.
|
void |
clearAwardIdTerms()
Clears the award
Id terms. |
void |
clearAwardTerms()
Clears the award 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 |
clearDateAwardedTerms()
Clears the award date terms.
|
void |
clearProgramIdTerms()
Clears the program
Id terms. |
void |
clearProgramTerms()
Clears the program terms.
|
void |
clearStudentIdTerms()
Clears the student
Id terms. |
void |
clearStudentTerms()
Clears the student option terms.
|
AssessmentQuery |
getAssessmentQuery()
Gets the query for an assessment entry.
|
AwardEntryQueryRecord |
getAwardEntryQueryRecord(Type awardEntryRecordType)
Gets the award entry query record corresponding to the given
AwardEntry record Type. |
AwardQuery |
getAwardQuery()
Gets the query for an award entry.
|
CourseCatalogQuery |
getCourseCatalogQuery()
Gets the query for a course catalog.
|
CourseQuery |
getCourseQuery()
Gets the query for a course entry.
|
ProgramQuery |
getProgramQuery()
Gets the query for a program.
|
ResourceQuery |
getStudentQuery()
Gets the query for a student option.
|
void |
matchAnyAssessment(boolean match)
Matches entries that have any assessment.
|
void |
matchAnyCourse(boolean match)
Matches entries that have any course.
|
void |
matchAnyDateAwarded(boolean match)
Matches entries that have any award date.
|
void |
matchAnyProgram(boolean match)
Matches entries that have any program.
|
void |
matchAssessmentId(Id assessmentId,
boolean match)
Sets the assessment
Id for this query to match entries
that have an entry for the given assessment, |
void |
matchAwardId(Id awardId,
boolean match)
Sets the award
Id for this query to match entries that
have an entry for the given course. |
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 |
matchDateAwarded(DateTime from,
DateTime to,
boolean match)
Matches award dates between the given dates inclusive.
|
void |
matchProgramId(Id programId,
boolean match)
Sets the program
Id for this query. |
void |
matchStudentId(Id resourceId,
boolean match)
Sets the student
Id for this query. |
boolean |
supportsAssessmentQuery()
Tests if an
AssessmentQuery is available. |
boolean |
supportsAwardQuery()
Tests if an
AwardQuery is available. |
boolean |
supportsCourseCatalogQuery()
Tests if a
CourseCatalogQuery is available. |
boolean |
supportsCourseQuery()
Tests if a
CourseQuery is available. |
boolean |
supportsProgramQuery()
Tests if a
ProgramQuery is available. |
boolean |
supportsStudentQuery()
Tests if a
StudentQuery 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 matchAwardId(Id awardId, boolean match)
Id
for this query to match entries that
have an entry for the given course.awardId
- an award Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- awardId
is
null
mandatory
- This method must be implemented. void clearAwardIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAwardQuery()
AwardQuery
is available. true
if an award query is available,
false
otherwisemandatory
- This method must be implemented. AwardQuery getAwardQuery()
OR
term.UnimplementedException
- supportsAwardQuery()
is false
optional
- This method must be implemented if
supportsAwardQuery()
is true.
void clearAwardTerms()
mandatory
- This method must be implemented. void matchDateAwarded(DateTime from, DateTime to, boolean match)
from
- starting dateto
- ending datematch
- 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 matchAnyDateAwarded(boolean match)
match
- true
to match entries with any award
date, false
to match entries with no award datemandatory
- This method must be implemented. void clearDateAwardedTerms()
mandatory
- This method must be implemented. void matchProgramId(Id programId, boolean match)
Id
for this query.programId
- a program Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- programId
is
null
mandatory
- This method must be implemented. void clearProgramIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsProgramQuery()
ProgramQuery
is available. true
if a program query is available,
false
otherwisemandatory
- This method must be implemented. ProgramQuery getProgramQuery()
OR
term.UnimplementedException
- supportsProgramQuery()
is false
optional
- This method must be implemented if
supportsProgramQuery()
is true.
void matchAnyProgram(boolean match)
match
- true
to match entries with any program
false
to match entries with no programmandatory
- This method must be implemented. void clearProgramTerms()
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 matchAnyCourse(boolean match)
match
- true
to match entries with any course,
false
to match entries with no coursemandatory
- This method must be implemented. void clearCourseTerms()
mandatory
- This method must be implemented. void matchAssessmentId(Id assessmentId, boolean match)
Id
for this query to match entries
that have an entry for the given assessment,assessmentId
- an assessment Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- assessmentId
is
null
mandatory
- This method must be implemented. void clearAssessmentIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAssessmentQuery()
AssessmentQuery
is available. true
if an assessment query is available,
false
otherwisemandatory
- This method must be implemented. AssessmentQuery getAssessmentQuery()
OR
term.UnimplementedException
-
supportsAssessmentQuery()
is false
optional
- This method must be implemented if
supportsAssessmentQuery()
is true.
void matchAnyAssessment(boolean match)
match
- true
to match entries with any
assessment, false
to match entries with no
assessmentmandatory
- This method must be implemented. void clearAssessmentTerms()
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. AwardEntryQueryRecord getAwardEntryQueryRecord(Type awardEntryRecordType) throws OperationFailedException
AwardEntry
record Type.
Multiple record
retrievals produce a nested OR
term.awardEntryRecordType
- an award entry record typeNullArgumentException
- awardEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(awardEntryRecordType)
is false
mandatory
- This method must be implemented.