org.osid.grading

Interface GradebookColumnQuery

All Superinterfaces:

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

public interface GradebookColumnQuery
extends OsidObjectQuery

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	clearGradebookColumnSummaryTerms() Clears the gradebook column summary terms.
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.
GradebookColumnQueryRecord	getGradebookColumnQueryRecord(Type gradebookColumnRecordType) Gets the gradebook column query record corresponding to the given GradebookColumn record Type.
GradebookColumnSummaryQuery	getGradebookColumnSummaryQuery() Gets the query interface for a gradebook column summary.
GradebookQuery	getGradebookQuery() Gets the query interface for a gradebook.
GradeEntryQuery	getGradeEntryQuery() Gets the query for a grade entry.
GradeSystemQuery	getGradeSystemQuery() Gets the query for a grade system.
void	matchAnyGradeEntry(boolean match) Matches gradebook columns with any grade entry assigned.
void	matchAnyGradeSystem(boolean match) Matches gradebook columns with any grade system assigned.
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.
boolean	supportsGradebookColumnSummaryQuery() Tests if a GradebookColumnSummaryQuery is available for querying grade systems.
boolean	supportsGradebookQuery() Tests if a GradebookQuery is available for querying grade systems.
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 a 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.

matchAnyGradeSystem

void matchAnyGradeSystem(boolean match)

Matches gradebook columns with any grade system assigned.

Parameters:

match - true to match columns with any grade system, false to match columns with no grade system

Compliance:

mandatory - This method must be implemented.

clearGradeSystemTerms

void clearGradeSystemTerms()

Clears the grade system 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 a 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 gradebook columns with any grade entry assigned.

Parameters:

match - true to match columns with any grade entry, false to match columns with no grade entries

Compliance:

mandatory - This method must be implemented.

clearGradeEntryTerms

void clearGradeEntryTerms()

Clears the grade entry terms.

Compliance:

mandatory - This method must be implemented.

supportsGradebookColumnSummaryQuery

boolean supportsGradebookColumnSummaryQuery()

Tests if a GradebookColumnSummaryQuery is available for querying grade systems.

Returns:

true if a gradebook column summary query interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradebookColumnSummaryQuery

GradebookColumnSummaryQuery getGradebookColumnSummaryQuery()

Gets the query interface for a gradebook column summary. Multiple retrievals produce a nested OR term.

Returns:

the gradebook column summary query

Throws:

UnimplementedException - supportsGradebookColumnSummaryQuery() is false

Compliance:

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

clearGradebookColumnSummaryTerms

void clearGradebookColumnSummaryTerms()

Clears the gradebook column summary 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 for querying grade systems.

Returns:

true if a gradebook query interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradebookQuery

GradebookQuery getGradebookQuery()

Gets the query interface 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.

getGradebookColumnQueryRecord

GradebookColumnQueryRecord getGradebookColumnQueryRecord(Type gradebookColumnRecordType)
                                                         throws OperationFailedException

Gets the gradebook column query record corresponding to the given GradebookColumn record Type. Multiple retrievals produce a nested OR term.

Parameters:

gradebookColumnRecordType - a gradebook column record type

Returns:

the gradebook column query record

Throws:

NullArgumentException - gradebookColumnRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradebookColumnRecordType) is false

Compliance:

mandatory - This method must be implemented.