org.osid.grading

Interface GradebookQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface GradebookQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining gradebook queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorGradebookIdTerms() Gets the ancestor gradebook Id terms.
GradebookQueryInspector[]	getAncestorGradebookTerms() Gets the ancestor gradebook terms.
IdTerm[]	getDescendantGradebookIdTerms() Gets the descendant gradebook Id terms.
GradebookQueryInspector[]	getDescendantGradebookTerms() Gets the descendant gradebook terms.
IdTerm[]	getGradebookColumnIdTerms() Gets the gradebook column Id terms.
GradebookColumnQueryInspector[]	getGradebookColumnTerms() Gets the gradebook column terms.
GradebookQueryInspectorRecord	getGradebookQueryInspectorRecord(Type gradebookRecordType) Gets the gradebook query inspector record corresponding to the given Gradebook record Type.
IdTerm[]	getGradeEntryIdTerms() Gets the grade entry Id terms.
GradeEntryQueryInspector[]	getGradeEntryTerms() Gets the grade entry terms.
IdTerm[]	getGradeSystemIdTerms() Gets the grade system Id terms.
GradeSystemQueryInspector[]	getGradeSystemTerms() Gets the grade system terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getGradeSystemIdTerms

IdTerm[] getGradeSystemIdTerms()

Gets the grade system Id terms.

Returns:

the grade system Id terms

Compliance:

mandatory - This method must be implemented.

getGradeSystemTerms

GradeSystemQueryInspector[] getGradeSystemTerms()

Gets the grade system terms.

Returns:

the grade system terms

Compliance:

mandatory - This method must be implemented.

getGradeEntryIdTerms

IdTerm[] getGradeEntryIdTerms()

Gets the grade entry Id terms.

Returns:

the grade entry Id terms

Compliance:

mandatory - This method must be implemented.

getGradeEntryTerms

GradeEntryQueryInspector[] getGradeEntryTerms()

Gets the grade entry terms.

Returns:

the grade entry terms

Compliance:

mandatory - This method must be implemented.

getGradebookColumnIdTerms

IdTerm[] getGradebookColumnIdTerms()

Gets the gradebook column Id terms.

Returns:

the gradebook column Id terms

Compliance:

mandatory - This method must be implemented.

getGradebookColumnTerms

GradebookColumnQueryInspector[] getGradebookColumnTerms()

Gets the gradebook column terms.

Returns:

the gradebook column terms

Compliance:

mandatory - This method must be implemented.

getAncestorGradebookIdTerms

IdTerm[] getAncestorGradebookIdTerms()

Gets the ancestor gradebook Id terms.

Returns:

the ancestor gradebook Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorGradebookTerms

GradebookQueryInspector[] getAncestorGradebookTerms()

Gets the ancestor gradebook terms.

Returns:

the ancestor gradebook terms

Compliance:

mandatory - This method must be implemented.

getDescendantGradebookIdTerms

IdTerm[] getDescendantGradebookIdTerms()

Gets the descendant gradebook Id terms.

Returns:

the descendant gradebook Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantGradebookTerms

GradebookQueryInspector[] getDescendantGradebookTerms()

Gets the descendant gradebook terms.

Returns:

the descendant gradebook terms

Compliance:

mandatory - This method must be implemented.

getGradebookQueryInspectorRecord

GradebookQueryInspectorRecord getGradebookQueryInspectorRecord(Type gradebookRecordType)
                                                               throws OperationFailedException

Gets the gradebook query inspector record corresponding to the given Gradebook record Type.

Parameters:

gradebookRecordType - a gradebook record type

Returns:

the gradebook query inspector record

Throws:

NullArgumentException - gradebookRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradebookRecordType) is false

Compliance:

mandatory - This method must be implemented.