org.osid.grading

Interface GradeQuery

All Superinterfaces:

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

public interface GradeQuery
extends OsidObjectQuery, OsidSubjugateableQuery

This is the query for searching gradings. 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	clearGradebookIdTerms() Clears the gradebook Id terms.
void	clearGradebookTerms() Clears the gradebook 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.
void	clearInputScoreEndRangeTerms() Clears the nput score start range terms.
void	clearInputScoreStartRangeTerms() Clears the nput score start range terms.
void	clearInputScoreTerms() Clears the input score start range terms.
void	clearOutputScoreTerms() Clears the output score terms.
GradebookQuery	getGradebookQuery() Gets the query for a gradebook.
GradeEntryQuery	getGradeEntryQuery() Gets the query for a grade entry.
GradeQueryRecord	getGradeQueryRecord(Type gradeRecordType) Gets the grade query record corresponding to the given Grade record Type.
GradeSystemQuery	getGradeSystemQuery() Gets the query for a grade system.
void	matchAnyGradeEntry(boolean match) Matches grades that are assigned to any grade entry.
void	matchGradebookId(Id gradebookId, boolean match) Sets the gradebook 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.
void	matchInputScore(java.math.BigDecimal start, java.math.BigDecimal end, boolean match) Matches grades with the input score range contained within the given range inclusive.
void	matchInputScoreEndRange(java.math.BigDecimal start, java.math.BigDecimal end, boolean match) Matches grades with the end input score inclusive.
void	matchInputScoreStartRange(java.math.BigDecimal start, java.math.BigDecimal end, boolean match) Matches grades with the start input score inclusive.
void	matchOutputScore(java.math.BigDecimal start, java.math.BigDecimal end, boolean match) Matches grades with the output score contained within the given range inclusive.
boolean	supportsGradebookQuery() Tests if a GradebookQuery is available .
boolean	supportsGradeEntryQuery() Tests if a GradeEntryQuery is available for querying grade entries.
boolean	supportsGradeSystemQuery() Tests if a GradeSystemQuery is available for querying grade systems.

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

matchGradeSystemId

void matchGradeSystemId(Id gradeSystemId,
                      boolean match)

Sets the grade system Id for this query.

Parameters:

gradeSystemId - a grade system Id

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

Throws:

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearGradeSystemIdTerms

void clearGradeSystemIdTerms()

Clears the grade system Id terms.

Compliance:

mandatory - This method must be implemented.

supportsGradeSystemQuery

boolean supportsGradeSystemQuery()

Tests if a GradeSystemQuery is available for querying grade systems.

Returns:

true if a grade system query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeSystemQuery

GradeSystemQuery getGradeSystemQuery()

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

Returns:

the grade system query

Throws:

UnimplementedException - supportsGradeSystemQuery() is false

Compliance:

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

clearGradeSystemTerms

void clearGradeSystemTerms()

Clears the grade system terms.

Compliance:

mandatory - This method must be implemented.

matchInputScoreStartRange

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

Matches grades with the start input score inclusive.

Parameters:

start - start of range

end - end of range

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

Throws:

InvalidArgumentException - start is greater than end

Compliance:

mandatory - This method must be implemented.

clearInputScoreStartRangeTerms

void clearInputScoreStartRangeTerms()

Clears the nput score start range terms.

Compliance:

mandatory - This method must be implemented.

matchInputScoreEndRange

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

Matches grades with the end input score inclusive.

Parameters:

start - start of range

end - end of range

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

Throws:

InvalidArgumentException - start is greater than end

Compliance:

mandatory - This method must be implemented.

clearInputScoreEndRangeTerms

void clearInputScoreEndRangeTerms()

Clears the nput score start range terms.

Compliance:

mandatory - This method must be implemented.

matchInputScore

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

Matches grades with the input score range contained within the given range inclusive.

Parameters:

start - start of range

end - end of range

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

Throws:

InvalidArgumentException - start is greater than end

Compliance:

mandatory - This method must be implemented.

clearInputScoreTerms

void clearInputScoreTerms()

Clears the input score start range terms.

Compliance:

mandatory - This method must be implemented.

matchOutputScore

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

Matches grades with the output score contained within the given range inclusive.

Parameters:

start - start of range

end - end of range

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

Throws:

InvalidArgumentException - start is greater than end

Compliance:

mandatory - This method must be implemented.

clearOutputScoreTerms

void clearOutputScoreTerms()

Clears the output score terms.

Compliance:

mandatory - This method must be implemented.

matchGradeEntryId

void matchGradeEntryId(Id gradeEntryId,
                     boolean match)

Sets the grade entry Id for this query.

Parameters:

gradeEntryId - a grade entry Id

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

Throws:

NullArgumentException - gradeEntryId is null

Compliance:

mandatory - This method must be implemented.

clearGradeEntryIdTerms

void clearGradeEntryIdTerms()

Clears the grade entry Id terms.

Compliance:

mandatory - This method must be implemented.

supportsGradeEntryQuery

boolean supportsGradeEntryQuery()

Tests if a GradeEntryQuery is available for querying grade entries.

Returns:

true if a grade entry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeEntryQuery

GradeEntryQuery getGradeEntryQuery()

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

Returns:

the grade entry query

Throws:

UnimplementedException - supportsGradeEntryQuery() is false

Compliance:

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

matchAnyGradeEntry

void matchAnyGradeEntry(boolean match)

Matches grades that are assigned to any grade entry.

Parameters:

match - true to match grades used in any grade entry, false to match grades that are not used in any grade entries

Compliance:

mandatory - This method must be implemented.

clearGradeEntryTerms

void clearGradeEntryTerms()

Clears the grade entry 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 supportsGradebookColumnQuery() is true.

clearGradebookTerms

void clearGradebookTerms()

Clears the gradebook terms.

Compliance:

mandatory - This method must be implemented.

getGradeQueryRecord

GradeQueryRecord getGradeQueryRecord(Type gradeRecordType)
                                     throws OperationFailedException

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

Parameters:

gradeRecordType - a grade record type

Returns:

the grade query record

Throws:

NullArgumentException - gradeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradeRecordType) is false

Compliance:

mandatory - This method must be implemented.