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

Modifier and Type	Method	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(BigDecimal start, BigDecimal end, boolean match)	Matches grade systems whose high end score falls in the specified range inclusive.
void	matchLowestNumericScore(BigDecimal start, BigDecimal end, boolean match)	Matches grade systems whose low end score falls in the specified range inclusive.
void	matchNumericScoreIncrement(BigDecimal start, 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 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

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