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

Modifier and Type	Method	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 .Multiple retrievals produce a nested OR term.
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(BigDecimal start, BigDecimal end, boolean match)	Matches grades with the input score range contained within the given range inclusive.
void	matchInputScoreEndRange(BigDecimal start, BigDecimal end, boolean match)	Matches grades with the end input score inclusive.
void	matchInputScoreStartRange(BigDecimal start, BigDecimal end, boolean match)	Matches grades with the start input score inclusive.
void	matchOutputScore(BigDecimal start, 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 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

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 {@code supportsGradeSystemQuery()} is {@code true} .

clearGradeSystemTerms

void clearGradeSystemTerms()

Clears the grade system terms.

Compliance:

mandatory - This method must be implemented.

matchInputScoreStartRange

void matchInputScoreStartRange(BigDecimal start,
 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(BigDecimal start,
 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(BigDecimal start,
 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(BigDecimal start,
 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 {@code supportsGradeEntryQuery()} is {@code 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 {@code supportsGradebookColumnQuery()} is {@code 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.