org.osid.grading

Interface GradeSystemQuery

All Superinterfaces:

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

public interface GradeSystemQuery
extends OsidObjectQuery, OsidAggregateableQuery

This is the query for searching grade systems. 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	clearBasedOnGradesTerms() Clears the grade based terms.
void	clearGradebookColumnIdTerms() Clears the gradebook column Id terms.
void	clearGradebookColumnTerms() Clears the gradebook column terms.
void	clearGradebookIdTerms() Clears the gradebook Id terms.
void	clearGradebookTerms() Clears the gradebook terms.
void	clearGradeIdTerms() Clears the grade Id terms.
void	clearGradeTerms() Clears the grade terms.
void	clearHighestNumericScoreTerms() Clears the highest numeric score terms.
void	clearLowestNumericScoreTerms() Clears the lowest numeric score terms.
void	clearNumericScoreIncrementTerms() Clears the numeric score increment terms.
GradebookColumnQuery	getGradebookColumnQuery() Gets the query for a gradebook column.
GradebookQuery	getGradebookQuery() Gets the query for a gradebook.
GradeQuery	getGradeQuery() Gets the query for a grade.
GradeSystemQueryRecord	getGradeSystemQueryRecord(Type gradeSystemRecordType) Gets the grade system query record corresponding to the given GradeSystem record Type.
void	matchAnyGrade(boolean match) Matches grade systems with any grade.
void	matchAnyGradebookColumn(boolean match) Matches grade systems assigned to any gradebook column.
void	matchBasedOnGrades(boolean match) Matches grade systems based on grades.
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	matchGradeId(Id gradeId, boolean match) Sets the grade Id for this query.
void	matchHighestNumericScore(java.math.BigDecimal start, java.math.BigDecimal end, boolean match) Matches grade systems whose high end score falls in the specified range inclusive.
void	matchLowestNumericScore(java.math.BigDecimal start, java.math.BigDecimal end, boolean match) Matches grade systems whose low end score falls in the specified range inclusive.
void	matchNumericScoreIncrement(java.math.BigDecimal start, java.math.BigDecimal end, boolean match) Matches grade systems numeric score increment is between the specified range inclusive.
boolean	supportsGradebookColumnQuery() Tests if a GradebookColumnQuery is available.
boolean	supportsGradebookQuery() Tests if a GradebookQuery is available .
boolean	supportsGradeQuery() Tests if a GradeQuery is available for querying grades.

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

Method Detail

matchBasedOnGrades

void matchBasedOnGrades(boolean match)

Matches grade systems based on grades.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearBasedOnGradesTerms

void clearBasedOnGradesTerms()

Clears the grade based terms.

Compliance:

mandatory - This method must be implemented.

matchGradeId

void matchGradeId(Id gradeId,
                boolean match)

Sets the grade Id for this query.

Parameters:

gradeId - a grade Id

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

Throws:

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearGradeIdTerms

void clearGradeIdTerms()

Clears the grade Id terms.

Compliance:

mandatory - This method must be implemented.

supportsGradeQuery

boolean supportsGradeQuery()

Tests if a GradeQuery is available for querying grades.

Returns:

true if a grade query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeQuery

GradeQuery getGradeQuery()

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

Returns:

the grade query

Throws:

UnimplementedException - supportsGradeQuery() is false

Compliance:

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

matchAnyGrade

void matchAnyGrade(boolean match)

Matches grade systems with any grade.

Parameters:

match - true to match grade systems with any grade, false to match systems with no grade

Compliance:

mandatory - This method must be implemented.

clearGradeTerms

void clearGradeTerms()

Clears the grade terms.

Compliance:

mandatory - This method must be implemented.

matchLowestNumericScore

void matchLowestNumericScore(java.math.BigDecimal start,
                           java.math.BigDecimal end,
                           boolean match)

Matches grade systems whose low end score falls in the specified range inclusive.

Parameters:

start - low end of range

end - high end of range

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

Throws:

InvalidArgumentException - end is less than start

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearLowestNumericScoreTerms

void clearLowestNumericScoreTerms()

Clears the lowest numeric score terms.

Compliance:

mandatory - This method must be implemented.

matchNumericScoreIncrement

void matchNumericScoreIncrement(java.math.BigDecimal start,
                              java.math.BigDecimal end,
                              boolean match)

Matches grade systems numeric score increment is between the specified range inclusive.

Parameters:

start - low end of range

end - high end of range

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

Throws:

InvalidArgumentException - end is less than start

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearNumericScoreIncrementTerms

void clearNumericScoreIncrementTerms()

Clears the numeric score increment terms.

Compliance:

mandatory - This method must be implemented.

matchHighestNumericScore

void matchHighestNumericScore(java.math.BigDecimal start,
                            java.math.BigDecimal end,
                            boolean match)

Matches grade systems whose high end score falls in the specified range inclusive.

Parameters:

start - low end of range

end - high end of range

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

Throws:

InvalidArgumentException - end is less than start

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearHighestNumericScoreTerms

void clearHighestNumericScoreTerms()

Clears the highest numeric score terms.

Compliance:

mandatory - This method must be implemented.

matchGradebookColumnId

void matchGradebookColumnId(Id gradebookColumnId,
                          boolean match)

Sets the gradebook column Id for this query.

Parameters:

gradebookColumnId - a gradebook column Id

match - true for a positive match, false for 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.

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 grade systems assigned to any gradebook column.

Parameters:

match - true to match grade systems mapped to any column, false to match systems mapped to no columns

Compliance:

mandatory - This method must be implemented.

clearGradebookColumnTerms

void clearGradebookColumnTerms()

Clears the gradebook column 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 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 supportsGradebookQuery() is true.

clearGradebookTerms

void clearGradebookTerms()

Clears the gradebook terms.

Compliance:

mandatory - This method must be implemented.

getGradeSystemQueryRecord

GradeSystemQueryRecord getGradeSystemQueryRecord(Type gradeSystemRecordType)
                                                 throws OperationFailedException

Gets the grade system query record corresponding to the given GradeSystem record Type. Multiple retrievals produce a nested OR term.

Parameters:

gradeSystemRecordType - a grade system record type

Returns:

the grade system query record

Throws:

NullArgumentException - gradeSystemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradeSystemRecordType) is false

Compliance:

mandatory - This method must be implemented.