org.osid.grading

Interface GradebookColumnSummaryQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, Suppliable

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.

Method Summary

Methods

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 .

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

Methods inherited from interface org.osid.OsidObjectQuery

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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Method Detail

matchGradebookColumnId

void matchGradebookColumnId(Id gradebookColumnId,
                          boolean match)

Sets the gradebook column Id for this query.

Parameters:

gradebookColumnId - a gradeboo column Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - gradebookColumnId is null

Compliance:

mandatory - This method must be implemented.

clearGradebookColumnIdTerms

void clearGradebookColumnIdTerms()

Clears the gradebook column Id terms.

Compliance:

mandatory - This method must be implemented.

supportsGradebookColumnQuery

boolean supportsGradebookColumnQuery()

Tests if a GradebookColumnQuery is available for querying gradebook column.

Returns:

true if a gradebook column query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradebookColumnQuery

GradebookColumnQuery getGradebookColumnQuery()

Gets the query for a gradebook column. Multiple retrievals produce a nested OR term.

Returns:

the gradebook column query

Throws:

UnimplementedException - supportsGradebookColumnQuery() is false

Compliance:

optional - This method must be implemented if supportsGradebookColumnQuery() is true.

matchAnyGradebookColumn

void matchAnyGradebookColumn(boolean match)

Matches gradebook column derivations with any gradebookc olumn.

Parameters:

match - true to match gradebook column derivations with any gradebook column, false to match gradebook column derivations with no gradebook columns

Compliance:

mandatory - This method must be implemented.

clearGradebookColumnTerms

void clearGradebookColumnTerms()

Clears the source grade system terms.

Compliance:

mandatory - This method must be implemented.

matchMean

void matchMean(java.math.BigDecimal low,
             java.math.BigDecimal high,
             boolean match)

Matches a mean between the given values inclusive.

Parameters:

low - low end of range

high - high end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

Compliance:

mandatory - This method must be implemented.

clearMeanTerms

void clearMeanTerms()

Clears the mean terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumMean

void matchMinimumMean(java.math.BigDecimal value,
                    boolean match)

Matches a mean greater than or equal to the given value.

Parameters:

value - minimum value

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearMinimumMeanTerms

void clearMinimumMeanTerms()

Clears the minimum mean terms.

Compliance:

mandatory - This method must be implemented.

matchMedian

void matchMedian(java.math.BigDecimal low,
               java.math.BigDecimal high,
               boolean match)

Matches a median between the given values inclusive.

Parameters:

low - low end of range

high - high end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

Compliance:

mandatory - This method must be implemented.

clearMedianTerms

void clearMedianTerms()

Clears the median terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumMedian

void matchMinimumMedian(java.math.BigDecimal value,
                      boolean match)

Matches a median greater than or equal to the given value.

Parameters:

value - minimum value

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearMinimumMedianTerms

void clearMinimumMedianTerms()

Clears the minimum median terms.

Compliance:

mandatory - This method must be implemented.

matchMode

void matchMode(java.math.BigDecimal low,
             java.math.BigDecimal high,
             boolean match)

Matches a mode between the given values inclusive.

Parameters:

low - low end of range

high - high end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

Compliance:

mandatory - This method must be implemented.

clearModeTerms

void clearModeTerms()

Clears the mode terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumMode

void matchMinimumMode(java.math.BigDecimal value,
                    boolean match)

Matches a mode greater than or equal to the given value.

Parameters:

value - minimum value

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearMinimumModeTerms

void clearMinimumModeTerms()

Clears the minimum mode terms.

Compliance:

mandatory - This method must be implemented.

matchRMS

void matchRMS(java.math.BigDecimal low,
            java.math.BigDecimal high,
            boolean match)

Matches a root mean square between the given values inclusive.

Parameters:

low - low end of range

high - high end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

Compliance:

mandatory - This method must be implemented.

clearRMSTerms

void clearRMSTerms()

Clears the root mean square terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumRMS

void matchMinimumRMS(java.math.BigDecimal value,
                   boolean match)

Matches a root mean square greater than or equal to the given value.

Parameters:

value - minimum value

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearMinimumRMSTerms

void clearMinimumRMSTerms()

Clears the minimum RMS terms.

Compliance:

mandatory - This method must be implemented.

matchStandardDeviation

void matchStandardDeviation(java.math.BigDecimal low,
                          java.math.BigDecimal high,
                          boolean match)

Matches a standard deviation mean square between the given values inclusive.

Parameters:

low - low end of range

high - high end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

Compliance:

mandatory - This method must be implemented.

clearStandardDeviationTerms

void clearStandardDeviationTerms()

Clears the standard deviation terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumStandardDeviation

void matchMinimumStandardDeviation(java.math.BigDecimal value,
                                 boolean match)

Matches a standard deviation greater than or equal to the given value.

Parameters:

value - minimum value

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearMinimumStandardDeviationTerms

void clearMinimumStandardDeviationTerms()

Clears the minimum standard deviation terms.

Compliance:

mandatory - This method must be implemented.

matchSum

void matchSum(java.math.BigDecimal low,
            java.math.BigDecimal high,
            boolean match)

Matches a sum mean square between the given values inclusive.

Parameters:

low - low end of range

high - high end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - low is greater than high

Compliance:

mandatory - This method must be implemented.

clearSumTerms

void clearSumTerms()

Clears the sum terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumSum

void matchMinimumSum(java.math.BigDecimal value,
                   boolean match)

Matches a sum greater than or equal to the given value.

Parameters:

value - minimum value

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearMinimumSumTerms

void clearMinimumSumTerms()

Clears the minimum sum terms.

Compliance:

mandatory - This method must be implemented.

matchGradebookId

void matchGradebookId(Id gradebookId,
                    boolean match)

Sets the gradebook Id for this query.

Parameters:

gradebookId - a gradebook Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - gradebookId is null

Compliance:

mandatory - This method must be implemented.

clearGradebookIdTerms

void clearGradebookIdTerms()

Clears the gradebook Id terms.

Compliance:

mandatory - This method must be implemented.

supportsGradebookQuery

boolean supportsGradebookQuery()

Tests if a GradebookQuery is available .

Returns:

true if a gradebook query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradebookQuery

GradebookQuery getGradebookQuery()

Gets the query for a gradebook. Multiple retrievals produce a nested OR term.

Returns:

the gradebook query

Throws:

UnimplementedException - supportsGradebookQuery() is false

Compliance:

optional - This method must be implemented if supportsGradebookColumnQuery() is true.

clearGradebookTerms

void clearGradebookTerms()

Clears the gradebook terms.

Compliance:

mandatory - This method must be implemented.

getGradebookColumnSummaryQueryRecord

GradebookColumnSummaryQueryRecord getGradebookColumnSummaryQueryRecord(Type gradebookColumnSummaryRecordType)
                                                                       throws OperationFailedException

Gets the gradebook column summary query record corresponding to the given GradebookColumnSummary record Type. Multiple retrievals produce a nested OR term.

Parameters:

gradebookColumnSummaryRecordType - a gradebook column summary record type

Returns:

the gradebook column summary query record

Throws:

NullArgumentException - gradebookColumnSummaryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradebookColumnSummaryRecordType) is false

Compliance:

mandatory - This method must be implemented.