org.osid.grading

Interface GradebookQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface GradebookQuery
extends OsidCatalogQuery

This is the query for searching gradebooks. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAncestorGradebookIdTerms() Clears the ancestor gradebook Id terms.
void	clearAncestorGradebookTerms() Clears the ancestor gradebook terms.
void	clearDescendantGradebookIdTerms() Clears the descendant gradebook Id terms.
void	clearDescendantGradebookTerms() Clears the descendant gradebook terms.
void	clearGradebookColumnIdTerms() Clears the gradebook column Id terms.
void	clearGradebookColumnTerms() Clears the gradebook column 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.
GradebookQuery	getAncestorGradebookQuery() Gets the query for a gradebook.
GradebookQuery	getDescendantGradebookQuery() Gets the query for a gradebook.
GradebookColumnQuery	getGradebookColumnQuery() Gets the query for a gradebook column.
GradebookQueryRecord	getGradebookQueryRecord(Type gradebookRecordType) Gets the gradebook query record corresponding to the given Gradebook record Type.
GradeEntryQuery	getGradeEntryQuery() Gets the query for a grade entry.
GradeSystemQuery	getGradeSystemQuery() Gets the query for a grade system.
void	matchAncestorGradebookId(Id gradebookId, boolean match) Sets the gradebook Id for this query to match gradebooks that have the specified gradebook as an ancestor.
void	matchAnyAncestorGradebook(boolean match) Matches gradebook with any ancestor.
void	matchAnyDescendantGradebook(boolean match) Matches gradebook with any descendant.
void	matchAnyGradebookColumn(boolean match) Matches gradebooks that have any column.
void	matchAnyGradeEntry(boolean match) Matches gradebooks that have any grade entry.
void	matchAnyGradeSystem(boolean match) Matches gradebooks that have any grade system.
void	matchDescendantGradebookId(Id gradebookId, boolean match) Sets the gradebook Id for this query to match gradebooks that have the specified gradebook as a descendant.
void	matchGradebookColumnId(Id gradebookColumnId, boolean match) Sets the gradebook column 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	supportsAncestorGradebookQuery() Tests if a GradebookQuery is available.
boolean	supportsDescendantGradebookQuery() Tests if a GradebookQuery is available.
boolean	supportsGradebookColumnQuery() Tests if a GradebookColumnQuery is available.
boolean	supportsGradeEntryQuery() Tests if a GradeEntryQuery is available.
boolean	supportsGradeSystemQuery() Tests if a GradeSystemQuery is available.

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

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

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.

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 gradebooks that have any grade system.

Parameters:

match - true to match gradebooks with any grade system, false to match gradebooks 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.

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 gradebooks that have any grade entry.

Parameters:

match - true to match gradebooks with any grade entry, false to match gradebooks with no grade entry

Compliance:

mandatory - This method must be implemented.

clearGradeEntryTerms

void clearGradeEntryTerms()

Clears the grade entry 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 a 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 gradebooks that have any column.

Parameters:

match - true to match gradebooks with any column, false to match gradebooks with no column

Compliance:

mandatory - This method must be implemented.

clearGradebookColumnTerms

void clearGradebookColumnTerms()

Clears the gradebook column terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorGradebookId

void matchAncestorGradebookId(Id gradebookId,
                            boolean match)

Sets the gradebook Id for this query to match gradebooks that have the specified gradebook as an ancestor.

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.

clearAncestorGradebookIdTerms

void clearAncestorGradebookIdTerms()

Clears the ancestor gradebook Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorGradebookQuery

boolean supportsAncestorGradebookQuery()

Tests if a GradebookQuery is available.

Returns:

true if a gradebook query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorGradebookQuery

GradebookQuery getAncestorGradebookQuery()

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

Returns:

the gradebook query

Throws:

UnimplementedException - supportsAncestorGradebookQuery() is false

Compliance:

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

matchAnyAncestorGradebook

void matchAnyAncestorGradebook(boolean match)

Matches gradebook with any ancestor.

Parameters:

match - true to match gradebooks with any ancestor, false to match root gradebooks

Compliance:

mandatory - This method must be implemented.

clearAncestorGradebookTerms

void clearAncestorGradebookTerms()

Clears the ancestor gradebook terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantGradebookId

void matchDescendantGradebookId(Id gradebookId,
                              boolean match)

Sets the gradebook Id for this query to match gradebooks that have the specified gradebook as a descendant.

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.

clearDescendantGradebookIdTerms

void clearDescendantGradebookIdTerms()

Clears the descendant gradebook Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantGradebookQuery

boolean supportsDescendantGradebookQuery()

Tests if a GradebookQuery is available.

Returns:

true if a gradebook query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantGradebookQuery

GradebookQuery getDescendantGradebookQuery()

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

Returns:

the gradebook query

Throws:

UnimplementedException - supportsDescendantGradebookQuery() is false

Compliance:

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

matchAnyDescendantGradebook

void matchAnyDescendantGradebook(boolean match)

Matches gradebook with any descendant.

Parameters:

match - true to match gradebooks with any descendant, false to match leaf gradebooks

Compliance:

mandatory - This method must be implemented.

clearDescendantGradebookTerms

void clearDescendantGradebookTerms()

Clears the descendant gradebook terms.

Compliance:

mandatory - This method must be implemented.

getGradebookQueryRecord

GradebookQueryRecord getGradebookQueryRecord(Type gradebookRecordType)
                                             throws OperationFailedException

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

Parameters:

gradebookRecordType - a gradebook record type

Returns:

the gradebook query record

Throws:

NullArgumentException - gradebookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradebookRecordType) is false

Compliance:

mandatory - This method must be implemented.