OSID Logo
OSID Specifications
grading package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.GradeEntryQuery
Implementsosid.OsidRelationshipQuery
Description

This is the query for searching grade entries. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

MethodmatchGradebookColumnId
Description

Sets the gradebook column Id for this query.

Parametersosid.id.IdgradebookColumnIda gradebook column Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT gradebookColumnId is null
CompliancemandatoryThis method must be implemented.
MethodclearGradebookColumnIdTerms
Description

Clears the gradebook column Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsGradebookColumnQuery
Description

Tests if a GradebookColumnQuery is available for querying creators.

Returnboolean true if a gradebook column query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradebookColumnQuery
Description

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

Returnosid.grading.GradebookColumnQuerythe gradebook column query
ErrorsUNIMPLEMENTED supportsGradebookColumnQuery() is false
ComplianceoptionalThis method must be implemented if supportsGradebookColumnQuery() is true.
MethodclearGradebookColumnTerms
Description

Clears the gradebook column terms.

CompliancemandatoryThis method must be implemented.
MethodmatchKeyResourceId
Description

Sets the key resource Id for this query.

Parametersosid.id.IdresourceIda resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearKeyResourceIdTerms
Description

Clears the key resource Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsKeyResourceQuery
Description

Tests if a ResourceQUery is available for querying key resources.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetKeyResourceQuery
Description

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

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsKeyResourceQuery() is false
ComplianceoptionalThis method must be implemented if supportsKeyResourceQuery() is true.
MethodmatchAnyKeyResource
Description

Matches grade entries with any key resource.

Parametersbooleanmatch true to match grade entries with any key resource, false to match entries with no key resource
CompliancemandatoryThis method must be implemented.
MethodclearKeyResourceTerms
Description

Clears the key resource terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDerived
Description

Matches derived grade entries.

Parametersbooleanmatch true to match derived grade entries , false to match manual entries
CompliancemandatoryThis method must be implemented.
MethodclearDerivedTerms
Description

Clears the derived terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOverriddenGradeEntryId
Description

Sets the grade entry Id for an overridden calculated grade entry.

Parametersosid.id.IdgradeEntryIda grade entry Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT gradeEntryId is null
CompliancemandatoryThis method must be implemented.
MethodclearOverriddenGradeEntryIdTerms
Description

Clears the overridden grade entry Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsOverriddenGradeEntryQuery
Description

Tests if a GradeEntry is available for querying overridden calculated grade entries.

Returnboolean true if a grade entry query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetOverriddenGradeEntryQuery
Description

Gets the query for an overridden derived grade entry. Multiple retrievals produce a nested OR term.

Returnosid.grading.GradeEntryQuerythe grade entry query
ErrorsUNIMPLEMENTED supportsOverriddenGradeEntryQuery() is false
ComplianceoptionalThis method must be implemented if supportsOverriddenGradeEntryQuery() is true.
MethodmatchAnyOverriddenGradeEntry
Description

Matches grade entries overriding any calculated grade entry.

Parametersbooleanmatch true to match grade entries overriding any grade entry, false to match entries not overriding any entry
CompliancemandatoryThis method must be implemented.
MethodclearOverriddenGradeEntryTerms
Description

Clears the overridden grade entry terms.

CompliancemandatoryThis method must be implemented.
MethodmatchIgnoredForCalculations
Description

Matches grade entries ignored for calculations.

Parametersbooleanmatch true to match grade entries ignored for calculations, false to match entries used in calculations
CompliancemandatoryThis method must be implemented.
MethodclearIgnoredForCalculationsTerms
Description

Clears the ignored for calculation entries terms.

CompliancemandatoryThis method must be implemented.
MethodmatchGradeId
Description

Sets the grade Id for this query.

Parametersosid.id.IdgradeIda grade Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT gradeId is null
CompliancemandatoryThis method must be implemented.
MethodclearGradeIdTerms
Description

Clears the grade Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsGradeQuery
Description

Tests if a GradeQuery is available for querying grades.

Returnboolean true if a grade query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradeQuery
Description

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

Returnosid.grading.GradeQuerythe grade query
ErrorsUNIMPLEMENTED supportsGradeQuery() is false
ComplianceoptionalThis method must be implemented if supportsGradeQuery() is true.
MethodmatchAnyGrade
Description

Matches grade entries with any grade.

Parametersbooleanmatch true to match grade entries with any grade, false to match entries with no grade
CompliancemandatoryThis method must be implemented.
MethodclearGradeTerms
Description

Clears the grade terms.

CompliancemandatoryThis method must be implemented.
MethodmatchScore
Description

Matches grade entries which score is between the specified score inclusive.

Parametersdecimalstartstart of range
decimalendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT end is less than start
CompliancemandatoryThis method must be implemented.
MethodmatchAnyScore
Description

Matches grade entries with any score.

Parametersbooleanmatch true to match grade entries with any score, false to match entries with no score
CompliancemandatoryThis method must be implemented.
MethodclearScoreTerms
Description

Clears the score terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTimeGraded
Description

Matches grade entries which graded time is between the specified times inclusive.

Parametersosid.calendaring.DateTimestartstart of range
osid.calendaring.DateTimeendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT end is less than start
CompliancemandatoryThis method must be implemented.
MethodclearTimeGradedTerms
Description

Clears the time graded terms.

CompliancemandatoryThis method must be implemented.
MethodmatchGraderId
Description

Sets the agent Id for this query.

Parametersosid.id.IdresourceIda resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearGraderIdTerms
Description

Clears the grader Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsGraderQuery
Description

Tests if a ResourceQuery is available for querying graders.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGraderQuery
Description

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

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsResourceQuery() is false
ComplianceoptionalThis method must be implemented if supportsResourceQuery() is true.
MethodmatchAnyGrader
Description

Matches grade entries with any grader.

Parametersbooleanmatch true to match grade entries with any grader, false to match entries with no grader
CompliancemandatoryThis method must be implemented.
MethodclearGraderTerms
Description

Clears the grader terms.

CompliancemandatoryThis method must be implemented.
MethodmatchGradingAgentId
Description

Sets the grading agent Id for this query.

Parametersosid.id.IdagentIdan agent Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT agentId is null
CompliancemandatoryThis method must be implemented.
MethodclearGradingAgentIdTerms
Description

Clears the grader Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsGradingAgentQuery
Description

Tests if an AgentQuery is available for querying grading agents.

Returnboolean true if an agent query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradingAgentQuery
Description

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

Returnosid.authentication.AgentQuerythe agent query
ErrorsUNIMPLEMENTED supportsGradingAgentQuery() is false
ComplianceoptionalThis method must be implemented if supportsGradingAgentQuery() is true.
MethodmatchAnyGradingAgent
Description

Matches grade entries with any grading agent.

Parametersbooleanmatch true to match grade entries with any grading agent, false to match entries with no grading agent
CompliancemandatoryThis method must be implemented.
MethodclearGradingAgentTerms
Description

Clears the grading agent terms.

CompliancemandatoryThis method must be implemented.
MethodmatchGradebookId
Description

Sets the gradebook Id for this query.

Parametersosid.id.IdgradebookIda gradebook Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT gradebookId is null
CompliancemandatoryThis method must be implemented.
MethodclearGradebookIdTerms
Description

Clears the gradebook Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsGradebookQuery
Description

Tests if a GradebookQuery is available for querying resources.

Returnboolean true if a gradebook query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradebookQuery
Description

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

Returnosid.grading.GradebookQuerythe gradebook query
ErrorsUNIMPLEMENTED supportsGradebookQuery() is false
ComplianceoptionalThis method must be implemented if supportsGradebookQuery() is true.
MethodclearGradebookTerms
Description

Clears the gradebook terms.

CompliancemandatoryThis method must be implemented.
MethodgetGradeEntryQueryRecord
Description

Gets the grade entry query record corresponding to the given GradeEntry record Type. Multiple retrievals produce a nested OR term.

Parametersosid.type.TypegradeEntryRecordTypea grade entry record type
Returnosid.grading.records.GradeEntryQueryRecordthe grade entry query record
ErrorsNULL_ARGUMENT gradeEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(gradeEntryRecordType) is false
CompliancemandatoryThis method must be implemented.