public interface GradebookQuery extends OsidCatalogQuery
This is the query for searching gradebooks. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorGradebookIdTerms()
Clears the ancestor gradebook
Id terms. |
void |
clearAncestorGradebookTerms()
Clears the ancestor gradebook terms.
|
void |
clearDescendantGradebookIdTerms()
Clears the descendant gradebook
Id terms. |
void |
clearDescendantGradebookTerms()
Clears the descendant gradebook terms.
|
void |
clearGradebookColumnIdTerms()
Clears the gradebook column
Id terms. |
void |
clearGradebookColumnTerms()
Clears the gradebook column terms.
|
void |
clearGradeEntryIdTerms()
Clears the grade entry
Id terms. |
void |
clearGradeEntryTerms()
Clears the grade entry terms.
|
void |
clearGradeSystemIdTerms()
Clears the grade system
Id terms. |
void |
clearGradeSystemTerms()
Clears the grade system terms.
|
GradebookQuery |
getAncestorGradebookQuery()
Gets the query for a gradebook.
|
GradebookQuery |
getDescendantGradebookQuery()
Gets the query for a gradebook.
|
GradebookColumnQuery |
getGradebookColumnQuery()
Gets the query for a gradebook column.
|
GradebookQueryRecord |
getGradebookQueryRecord(Type gradebookRecordType)
Gets the gradebook query record corresponding to the given
Gradebook record Type. |
GradeEntryQuery |
getGradeEntryQuery()
Gets the query for a grade entry.
|
GradeSystemQuery |
getGradeSystemQuery()
Gets the query for a grade system.
|
void |
matchAncestorGradebookId(Id gradebookId,
boolean match)
Sets the gradebook
Id for this query to match
gradebooks that have the specified gradebook as an ancestor. |
void |
matchAnyAncestorGradebook(boolean match)
Matches gradebook with any ancestor.
|
void |
matchAnyDescendantGradebook(boolean match)
Matches gradebook with any descendant.
|
void |
matchAnyGradebookColumn(boolean match)
Matches gradebooks that have any column.
|
void |
matchAnyGradeEntry(boolean match)
Matches gradebooks that have any grade entry.
|
void |
matchAnyGradeSystem(boolean match)
Matches gradebooks that have any grade system.
|
void |
matchDescendantGradebookId(Id gradebookId,
boolean match)
Sets the gradebook
Id for this query to match
gradebooks that have the specified gradebook as a descendant. |
void |
matchGradebookColumnId(Id gradebookColumnId,
boolean match)
Sets the gradebook column
Id for this query. |
void |
matchGradeEntryId(Id gradeEntryId,
boolean match)
Sets the grade entry
Id for this query. |
void |
matchGradeSystemId(Id gradeSystemId,
boolean match)
Sets the grade system
Id for this query. |
boolean |
supportsAncestorGradebookQuery()
Tests if a
GradebookQuery is available. |
boolean |
supportsDescendantGradebookQuery()
Tests if a
GradebookQuery is available. |
boolean |
supportsGradebookColumnQuery()
Tests if a
GradebookColumnQuery is available. |
boolean |
supportsGradeEntryQuery()
Tests if a
GradeEntryQuery is available. |
boolean |
supportsGradeSystemQuery()
Tests if a
GradeSystemQuery is available. |
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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchGradeSystemId(Id gradeSystemId, boolean match)
Id
for this query.gradeSystemId
- a grade system Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- gradeSystemId
is
null
mandatory
- This method must be implemented. void clearGradeSystemIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsGradeSystemQuery()
GradeSystemQuery
is available. true
if a grade system query is available,
false
otherwisemandatory
- This method must be implemented. GradeSystemQuery getGradeSystemQuery()
OR
term.UnimplementedException
-
supportsGradeSystemQuery()
is false
optional
- This method must be implemented if
supportsGradeSystemQuery()
is true.
void matchAnyGradeSystem(boolean match)
match
- true
to match gradebooks with any grade
system, false
to match gradebooks with no grade
systemmandatory
- This method must be implemented. void clearGradeSystemTerms()
mandatory
- This method must be implemented. void matchGradeEntryId(Id gradeEntryId, boolean match)
Id
for this query.gradeEntryId
- a grade entry Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- gradeEntryId
is
null
mandatory
- This method must be implemented. void clearGradeEntryIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsGradeEntryQuery()
GradeEntryQuery
is available. true
if a grade entry query is available,
false
otherwisemandatory
- This method must be implemented. GradeEntryQuery getGradeEntryQuery()
OR
term.UnimplementedException
-
supportsGradeEntryQuery()
is false
optional
- This method must be implemented if
supportsGradeEntryQuery()
is true.
void matchAnyGradeEntry(boolean match)
match
- true
to match gradebooks with any grade
entry, false
to match gradebooks with no grade
entrymandatory
- This method must be implemented. void clearGradeEntryTerms()
mandatory
- This method must be implemented. void matchGradebookColumnId(Id gradebookColumnId, boolean match)
Id
for this query.gradebookColumnId
- a gradebook column Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- gradebookColumnId
is null
mandatory
- This method must be implemented. void clearGradebookColumnIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsGradebookColumnQuery()
GradebookColumnQuery
is available. true
if a gradebook column query is available,
false
otherwisemandatory
- This method must be implemented. GradebookColumnQuery getGradebookColumnQuery()
OR
term.UnimplementedException
-
supportsGradebookColumnQuery()
is false
optional
- This method must be implemented if
supportsGradebookColumnQuery()
is true.
void matchAnyGradebookColumn(boolean match)
match
- true
to match gradebooks with any column,
false
to match gradebooks with no columnmandatory
- This method must be implemented. void clearGradebookColumnTerms()
mandatory
- This method must be implemented. void matchAncestorGradebookId(Id gradebookId, boolean match)
Id
for this query to match
gradebooks that have the specified gradebook as an ancestor.gradebookId
- a gradebook Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- gradebookId
is
null
mandatory
- This method must be implemented. void clearAncestorGradebookIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorGradebookQuery()
GradebookQuery
is available. true
if a gradebook query is available,
false
otherwisemandatory
- This method must be implemented. GradebookQuery getAncestorGradebookQuery()
OR
term.UnimplementedException
-
supportsAncestorGradebookQuery()
is false
optional
- This method must be implemented if
supportsAncestorGradebookQuery()
is true.
void matchAnyAncestorGradebook(boolean match)
match
- true
to match gradebooks with any
ancestor, false
to match root gradebooksmandatory
- This method must be implemented. void clearAncestorGradebookTerms()
mandatory
- This method must be implemented. void matchDescendantGradebookId(Id gradebookId, boolean match)
Id
for this query to match
gradebooks that have the specified gradebook as a descendant.gradebookId
- a gradebook Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- gradebookId
is
null
mandatory
- This method must be implemented. void clearDescendantGradebookIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantGradebookQuery()
GradebookQuery
is available. true
if a gradebook query is available,
false
otherwisemandatory
- This method must be implemented. GradebookQuery getDescendantGradebookQuery()
OR
term.UnimplementedException
-
supportsDescendantGradebookQuery()
is false
optional
- This method must be implemented if
supportsDescendantGradebookQuery()
is true.
void matchAnyDescendantGradebook(boolean match)
match
- true
to match gradebooks with any
descendant, false
to match leaf gradebooksmandatory
- This method must be implemented. void clearDescendantGradebookTerms()
mandatory
- This method must be implemented. GradebookQueryRecord getGradebookQueryRecord(Type gradebookRecordType) throws OperationFailedException
Gradebook
record Type.
Multiple record
retrievals produce a nested OR
term.gradebookRecordType
- a gradebook record typeNullArgumentException
- gradebookRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(gradebookRecordType)
is false
mandatory
- This method must be implemented.