Interface GradebookColumnSummaryQuery

All Superinterfaces:

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

public interface GradebookColumnSummaryQuery
extends OsidObjectQuery

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

Modifier and Type	Method	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(BigDecimal low, BigDecimal high, boolean match)	Matches a mean between the given values inclusive.
void	matchMedian(BigDecimal low, BigDecimal high, boolean match)	Matches a median between the given values inclusive.
void	matchMinimumMean(BigDecimal value, boolean match)	Matches a mean greater than or equal to the given value.
void	matchMinimumMedian(BigDecimal value, boolean match)	Matches a median greater than or equal to the given value.
void	matchMinimumMode(BigDecimal value, boolean match)	Matches a mode greater than or equal to the given value.
void	matchMinimumRMS(BigDecimal value, boolean match)	Matches a root mean square greater than or equal to the given value.
void	matchMinimumStandardDeviation(BigDecimal value, boolean match)	Matches a standard deviation greater than or equal to the given value.
void	matchMinimumSum(BigDecimal value, boolean match)	Matches a sum greater than or equal to the given value.
void	matchMode(BigDecimal low, BigDecimal high, boolean match)	Matches a mode between the given values inclusive.
void	matchRMS(BigDecimal low, BigDecimal high, boolean match)	Matches a root mean square between the given values inclusive.
void	matchStandardDeviation(BigDecimal low, BigDecimal high, boolean match)	Matches a standard deviation mean square between the given values inclusive.
void	matchSum(BigDecimal low, 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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

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 {@code supportsGradebookColumnQuery()} is {@code 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(BigDecimal low,
 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(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(BigDecimal low,
 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(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(BigDecimal low,
 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(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(BigDecimal low,
 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(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(BigDecimal low,
 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(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(BigDecimal low,
 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(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 {@code supportsGradebookColumnQuery()} is {@code 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.