public interface GradebookColumnSummaryQuery extends OsidRuleQuery
This is the query for searching gradebook column summaries. Each method
match request produces an AND
term while multiple
invocations of a method produces a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearGradebookColumnIdTerms()
Clears the gradebook column
Id terms. |
void |
clearGradebookColumnTerms()
Clears the source grade system terms.
|
void |
clearGradebookIdTerms()
Clears the gradebook
Id terms. |
void |
clearGradebookTerms()
Clears the gradebook terms.
|
void |
clearMeanTerms()
Clears the mean terms.
|
void |
clearMedianTerms()
Clears the median terms.
|
void |
clearMinimumMeanTerms()
Clears the minimum mean terms.
|
void |
clearMinimumMedianTerms()
Clears the minimum median terms.
|
void |
clearMinimumModeTerms()
Clears the minimum mode terms.
|
void |
clearMinimumRMSTerms()
Clears the minimum RMS terms.
|
void |
clearMinimumStandardDeviationTerms()
Clears the minimum standard deviation terms.
|
void |
clearMinimumSumTerms()
Clears the minimum sum terms.
|
void |
clearModeTerms()
Clears the mode terms.
|
void |
clearRMSTerms()
Clears the root mean square terms.
|
void |
clearStandardDeviationTerms()
Clears the standard deviation terms.
|
void |
clearSumTerms()
Clears the sum terms.
|
GradebookColumnQuery |
getGradebookColumnQuery()
Gets the query for a gradebook column.
|
GradebookColumnSummaryQueryRecord |
getGradebookColumnSummaryQueryRecord(Type gradebookColumnSummaryRecordType)
Gets the gradebook column summary query record corresponding to the
given
GradebookColumnSummary record Type. |
GradebookQuery |
getGradebookQuery()
Gets the query for a gradebook.
|
void |
matchAnyGradebookColumn(boolean match)
Matches gradebook column derivations with any gradebookc olumn.
|
void |
matchGradebookColumnId(Id gradebookColumnId,
boolean match)
Sets the gradebook column
Id for this query. |
void |
matchGradebookId(Id gradebookId,
boolean match)
Sets the gradebook
Id for this query. |
void |
matchMean(java.math.BigDecimal low,
java.math.BigDecimal high,
boolean match)
Matches a mean between the given values inclusive.
|
void |
matchMedian(java.math.BigDecimal low,
java.math.BigDecimal high,
boolean match)
Matches a median between the given values inclusive.
|
void |
matchMinimumMean(java.math.BigDecimal value,
boolean match)
Matches a mean greater than or equal to the given value.
|
void |
matchMinimumMedian(java.math.BigDecimal value,
boolean match)
Matches a median greater than or equal to the given value.
|
void |
matchMinimumMode(java.math.BigDecimal value,
boolean match)
Matches a mode greater than or equal to the given value.
|
void |
matchMinimumRMS(java.math.BigDecimal value,
boolean match)
Matches a root mean square greater than or equal to the given value.
|
void |
matchMinimumStandardDeviation(java.math.BigDecimal value,
boolean match)
Matches a standard deviation greater than or equal to the given value.
|
void |
matchMinimumSum(java.math.BigDecimal value,
boolean match)
Matches a sum greater than or equal to the given value.
|
void |
matchMode(java.math.BigDecimal low,
java.math.BigDecimal high,
boolean match)
Matches a mode between the given values inclusive.
|
void |
matchRMS(java.math.BigDecimal low,
java.math.BigDecimal high,
boolean match)
Matches a root mean square between the given values inclusive.
|
void |
matchStandardDeviation(java.math.BigDecimal low,
java.math.BigDecimal high,
boolean match)
Matches a standard deviation mean square between the given values
inclusive.
|
void |
matchSum(java.math.BigDecimal low,
java.math.BigDecimal high,
boolean match)
Matches a sum mean square between the given values inclusive.
|
boolean |
supportsGradebookColumnQuery()
Tests if a
GradebookColumnQuery is available for
querying gradebook column. |
boolean |
supportsGradebookQuery()
Tests if a
GradebookQuery is available . |
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
void matchGradebookColumnId(Id gradebookColumnId, boolean match)
Id
for this query.gradebookColumnId
- a gradeboo 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 for
querying gradebook column. 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 gradebook column
derivations with any gradebook column, false
to
match gradebook column derivations with no gradebook columnsmandatory
- This method must be implemented. void clearGradebookColumnTerms()
mandatory
- This method must be implemented. void matchMean(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- low end of rangehigh
- high end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
mandatory
- This method must be implemented. void clearMeanTerms()
mandatory
- This method must be implemented. void matchMinimumMean(java.math.BigDecimal value, boolean match)
value
- minimum valuematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumMeanTerms()
mandatory
- This method must be implemented. void matchMedian(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- low end of rangehigh
- high end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
mandatory
- This method must be implemented. void clearMedianTerms()
mandatory
- This method must be implemented. void matchMinimumMedian(java.math.BigDecimal value, boolean match)
value
- minimum valuematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumMedianTerms()
mandatory
- This method must be implemented. void matchMode(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- low end of rangehigh
- high end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
mandatory
- This method must be implemented. void clearModeTerms()
mandatory
- This method must be implemented. void matchMinimumMode(java.math.BigDecimal value, boolean match)
value
- minimum valuematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumModeTerms()
mandatory
- This method must be implemented. void matchRMS(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- low end of rangehigh
- high end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
mandatory
- This method must be implemented. void clearRMSTerms()
mandatory
- This method must be implemented. void matchMinimumRMS(java.math.BigDecimal value, boolean match)
value
- minimum valuematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumRMSTerms()
mandatory
- This method must be implemented. void matchStandardDeviation(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- low end of rangehigh
- high end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
mandatory
- This method must be implemented. void clearStandardDeviationTerms()
mandatory
- This method must be implemented. void matchMinimumStandardDeviation(java.math.BigDecimal value, boolean match)
value
- minimum valuematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumStandardDeviationTerms()
mandatory
- This method must be implemented. void matchSum(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- low end of rangehigh
- high end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
mandatory
- This method must be implemented. void clearSumTerms()
mandatory
- This method must be implemented. void matchMinimumSum(java.math.BigDecimal value, boolean match)
value
- minimum valuematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumSumTerms()
mandatory
- This method must be implemented. void matchGradebookId(Id gradebookId, boolean match)
Id
for this query.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 clearGradebookIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsGradebookQuery()
GradebookQuery
is available . true
if a gradebook query is available,
false
otherwisemandatory
- This method must be implemented. GradebookQuery getGradebookQuery()
OR
term.UnimplementedException
-
supportsGradebookQuery()
is false
optional
- This method must be implemented if
supportsGradebookColumnQuery()
is true.
void clearGradebookTerms()
mandatory
- This method must be implemented. GradebookColumnSummaryQueryRecord getGradebookColumnSummaryQueryRecord(Type gradebookColumnSummaryRecordType) throws OperationFailedException
GradebookColumnSummary
record Type.
Multiple retrievals produce a nested OR
term.gradebookColumnSummaryRecordType
- a gradebook column summary
record typeNullArgumentException
-
gradebookColumnSummaryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(gradebookColumnSummaryRecordType)
is
false
mandatory
- This method must be implemented.