org.osid.grading

Interface GradingProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

GradingManager, GradingProxyManager

public interface GradingProfile
extends OsidProfile

The GradingProfile describes the interoperability among grading services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getGradebookColumnRecordTypes() Gets the supported GradebookColumn record types.
TypeList	getGradebookColumnSearchRecordTypes() Gets the supported gradebook column search record types.
TypeList	getGradebookColumnSummaryRecordTypes() Gets the supported GradebookColumnSummary record types.
TypeList	getGradebookRecordTypes() Gets the supported Gradebook record types.
TypeList	getGradebookSearchRecordTypes() Gets the supported gradebook search record types.
TypeList	getGradeEntryRecordTypes() Gets the supported GradeEntry record types.
TypeList	getGradeEntrySearchRecordTypes() Gets the supported GradeEntry search record types.
TypeList	getGradeRecordTypes() Gets the supported Grade record types.
TypeList	getGradeSystemRecordTypes() Gets the supported GradeSystem record types.
TypeList	getGradeSystemSearchRecordTypes() Gets the supported GradeSystem search record types.
boolean	supportsGradebookAdmin() Tests if a gradebook administrative service is supported.
boolean	supportsGradebookColumnAdmin() Tests if a gradebook column administrative service is supported.
boolean	supportsGradebookColumnGradebook() Tests if a gradebook column to gradebook lookup session is available.
boolean	supportsGradebookColumnGradebookAssignment() Tests if a gradebook column to gradebook assignment session is available.
boolean	supportsGradebookColumnLookup() Tests if a gradebook column lookup service is supported.
boolean	supportsGradebookColumnNotification() Tests if gradebook column notification is supported.
boolean	supportsGradebookColumnQuery() Tests if a gradebook column query service is supported.
boolean	supportsGradebookColumnRecordType(Type gradebookColumnRecordType) Tests if the given GradebookColumn record type is supported.
boolean	supportsGradebookColumnSearch() Tests if a gradebook column search service is supported.
boolean	supportsGradebookColumnSearchRecordType(Type gradebookColumnSearchRecordType) Tests if the given gradebook column search record type is supported.
boolean	supportsGradebookColumnSmartGradebook() Tests if a gradebook column smart gradebookt session is available.
boolean	supportsGradebookColumnSummaryRecordType(Type gradebookColumnSummaryRecordType) Tests if the given GradebookColumnSummary record type is supported.
boolean	supportsGradebookHierarchy() Tests if a gradebook hierarchy traversal is supported.
boolean	supportsGradebookHierarchyDesign() Tests if gradebook hierarchy design is supported.
boolean	supportsGradebookLookup() Tests if a gradebook lookup service is supported.
boolean	supportsGradebookNotification() Tests if gradebook notification is supported.
boolean	supportsGradebookQuery() Tests if a gradebook query service is supported.
boolean	supportsGradebookRecordType(Type gradebookRecordType) Tests if the given Gradebook record type is supported.
boolean	supportsGradebookSearch() Tests if a gradebook search service is supported.
boolean	supportsGradebookSearchRecordType(Type gradebookSearchRecordType) Tests if the given gradebook search record type is supported.
boolean	supportsGradeEntryAdmin() Tests if a grade entry administrative service is supported.
boolean	supportsGradeEntryLookup() Tests if a grade entry lookup service is supported.
boolean	supportsGradeEntryNotification() Tests if grade entry notification is supported.
boolean	supportsGradeEntryQuery() Tests if a grade entry query service is supported.
boolean	supportsGradeEntryRecordType(Type gradeEntryRecordType) Tests if the given GradeEntry record type is supported.
boolean	supportsGradeEntrySearch() Tests if a grade entry search service is supported.
boolean	supportsGradeEntrySearchRecordType(Type gradeEntrySearchRecordType) Tests if the given GradeEntry search record type is supported.
boolean	supportsGradeRecordType(Type gradeRecordType) Tests if the given Grade record type is supported.
boolean	supportsGradeSystemAdmin() Tests if a grade system administrative service is supported.
boolean	supportsGradeSystemGradebook() Tests if a grade system to gradebook lookup session is available.
boolean	supportsGradeSystemGradebookAssignment() Tests if a grade system to gradebook assignment session is available.
boolean	supportsGradeSystemLookup() Tests if a grade system lookup service is supported.
boolean	supportsGradeSystemNotification() Tests if grade system notification is supported.
boolean	supportsGradeSystemQuery() Tests if a grade system query service is supported.
boolean	supportsGradeSystemRecordType(Type gradeSystemRecordType) Tests if the given GradeSystem record type is supported.
boolean	supportsGradeSystemSearch() Tests if a grade system search service is supported.
boolean	supportsGradeSystemSearchRecordType(Type gradeSystemSearchRecordType) Tests if the given GradeSystem search record type is supported.
boolean	supportsGradeSystemSmartGradebook() Tests if a grade system smart gradebook session is available.
boolean	supportsGradingBatch() Tests if a grading batch service is supported.
boolean	supportsGradingCalculation() Tests if a grading calculation service is supported.
boolean	supportsGradingTransform() Tests if a grade system transform service is supported.
boolean	supportsVisibleFederation() Tests if federation is visible.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if federation is visible.

Returns:

true if visible federation is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradeSystemLookup

boolean supportsGradeSystemLookup()

Tests if a grade system lookup service is supported.

Returns:

true if grade system lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradeSystemQuery

boolean supportsGradeSystemQuery()

Tests if a grade system query service is supported.

Returns:

true if grade system query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradeSystemSearch

boolean supportsGradeSystemSearch()

Tests if a grade system search service is supported.

Returns:

true if grade system search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradeSystemAdmin

boolean supportsGradeSystemAdmin()

Tests if a grade system administrative service is supported.

Returns:

true if grade system admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradeSystemNotification

boolean supportsGradeSystemNotification()

Tests if grade system notification is supported. Messages may be sent when grade entries are created, modified, or deleted.

Returns:

true if grade system notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradeSystemGradebook

boolean supportsGradeSystemGradebook()

Tests if a grade system to gradebook lookup session is available.

Returns:

true if grade system gradebook lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradeSystemGradebookAssignment

boolean supportsGradeSystemGradebookAssignment()

Tests if a grade system to gradebook assignment session is available.

Returns:

true if grade system gradebook assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradeSystemSmartGradebook

boolean supportsGradeSystemSmartGradebook()

Tests if a grade system smart gradebook session is available.

Returns:

true if grade system smart gradebook is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradeEntryLookup

boolean supportsGradeEntryLookup()

Tests if a grade entry lookup service is supported.

Returns:

true if grade entry lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradeEntryQuery

boolean supportsGradeEntryQuery()

Tests if a grade entry query service is supported.

Returns:

true if grade entry query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradeEntrySearch

boolean supportsGradeEntrySearch()

Tests if a grade entry search service is supported.

Returns:

true if grade entry search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradeEntryAdmin

boolean supportsGradeEntryAdmin()

Tests if a grade entry administrative service is supported.

Returns:

true if grade entry admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradeEntryNotification

boolean supportsGradeEntryNotification()

Tests if grade entry notification is supported.

Returns:

true if grade entry notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradebookColumnLookup

boolean supportsGradebookColumnLookup()

Tests if a gradebook column lookup service is supported.

Returns:

true if gradebook column lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradebookColumnQuery

boolean supportsGradebookColumnQuery()

Tests if a gradebook column query service is supported.

Returns:

true if grade system query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradebookColumnSearch

boolean supportsGradebookColumnSearch()

Tests if a gradebook column search service is supported.

Returns:

true if grade system search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradebookColumnAdmin

boolean supportsGradebookColumnAdmin()

Tests if a gradebook column administrative service is supported.

Returns:

true if gradebook column admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradebookColumnNotification

boolean supportsGradebookColumnNotification()

Tests if gradebook column notification is supported. Messages may be sent when grade entries are created, modified, or deleted.

Returns:

true if gradebook column notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradebookColumnGradebook

boolean supportsGradebookColumnGradebook()

Tests if a gradebook column to gradebook lookup session is available.

Returns:

true if gradebook column gradebook lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradebookColumnGradebookAssignment

boolean supportsGradebookColumnGradebookAssignment()

Tests if a gradebook column to gradebook assignment session is available.

Returns:

true if gradebook column gradebook assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradebookColumnSmartGradebook

boolean supportsGradebookColumnSmartGradebook()

Tests if a gradebook column smart gradebookt session is available.

Returns:

true if gradebook column amsrt gradebook is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradebookLookup

boolean supportsGradebookLookup()

Tests if a gradebook lookup service is supported.

Returns:

true if gradebook lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradebookQuery

boolean supportsGradebookQuery()

Tests if a gradebook query service is supported.

Returns:

true if gradebook query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradebookSearch

boolean supportsGradebookSearch()

Tests if a gradebook search service is supported.

Returns:

true if gradebook search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradebookAdmin

boolean supportsGradebookAdmin()

Tests if a gradebook administrative service is supported.

Returns:

true if gradebook admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradebookNotification

boolean supportsGradebookNotification()

Tests if gradebook notification is supported. Messages may be sent when gradebooks are created, modified, or deleted.

Returns:

true if gradebook notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradebookHierarchy

boolean supportsGradebookHierarchy()

Tests if a gradebook hierarchy traversal is supported.

Returns:

true if a gradebook hierarchy traversal is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradebookHierarchyDesign

boolean supportsGradebookHierarchyDesign()

Tests if gradebook hierarchy design is supported.

Returns:

true if a gradebook hierarchy design is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradingBatch

boolean supportsGradingBatch()

Tests if a grading batch service is supported.

Returns:

true if a grading batch service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradingCalculation

boolean supportsGradingCalculation()

Tests if a grading calculation service is supported.

Returns:

true if a grading calculation service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsGradingTransform

boolean supportsGradingTransform()

Tests if a grade system transform service is supported.

Returns:

true if a grading transform service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeRecordTypes

TypeList getGradeRecordTypes()

Gets the supported Grade record types.

Returns:

a list containing the supported Grade record types

Compliance:

mandatory - This method must be implemented.

supportsGradeRecordType

boolean supportsGradeRecordType(Type gradeRecordType)

Tests if the given Grade record type is supported.

Parameters:

gradeRecordType - a Type indicating a Grade record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - gradeRecordType is null

Compliance:

mandatory - This method must be implemented.

getGradeSystemRecordTypes

TypeList getGradeSystemRecordTypes()

Gets the supported GradeSystem record types.

Returns:

a list containing the supported GradeSystem record types

Compliance:

mandatory - This method must be implemented.

supportsGradeSystemRecordType

boolean supportsGradeSystemRecordType(Type gradeSystemRecordType)

Tests if the given GradeSystem record type is supported.

Parameters:

gradeSystemRecordType - a Type indicating a GradeSystem record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - gradeSystemRecordType is null

Compliance:

mandatory - This method must be implemented.

getGradeSystemSearchRecordTypes

TypeList getGradeSystemSearchRecordTypes()

Gets the supported GradeSystem search record types.

Returns:

a list containing the supported GradeSystem search record types

Compliance:

mandatory - This method must be implemented.

supportsGradeSystemSearchRecordType

boolean supportsGradeSystemSearchRecordType(Type gradeSystemSearchRecordType)

Tests if the given GradeSystem search record type is supported.

Parameters:

gradeSystemSearchRecordType - a Type indicating a GradeSystem search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - gradeSystemSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getGradeEntryRecordTypes

TypeList getGradeEntryRecordTypes()

Gets the supported GradeEntry record types.

Returns:

a list containing the supported GradeEntry record types

Compliance:

mandatory - This method must be implemented.

supportsGradeEntryRecordType

boolean supportsGradeEntryRecordType(Type gradeEntryRecordType)

Tests if the given GradeEntry record type is supported.

Parameters:

gradeEntryRecordType - a Type indicating a GradeEntry record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - gradeEntryRecordType is null

Compliance:

mandatory - This method must be implemented.

getGradeEntrySearchRecordTypes

TypeList getGradeEntrySearchRecordTypes()

Gets the supported GradeEntry search record types.

Returns:

a list containing the supported GradeEntry search record types

Compliance:

mandatory - This method must be implemented.

supportsGradeEntrySearchRecordType

boolean supportsGradeEntrySearchRecordType(Type gradeEntrySearchRecordType)

Tests if the given GradeEntry search record type is supported.

Parameters:

gradeEntrySearchRecordType - a Type indicating a GradeEntry search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - gradeEntrySearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getGradebookColumnRecordTypes

TypeList getGradebookColumnRecordTypes()

Gets the supported GradebookColumn record types.

Returns:

a list containing the supported GradebookColumn record types

Compliance:

mandatory - This method must be implemented.

supportsGradebookColumnRecordType

boolean supportsGradebookColumnRecordType(Type gradebookColumnRecordType)

Tests if the given GradebookColumn record type is supported.

Parameters:

gradebookColumnRecordType - a Type indicating a GradebookColumn type

Returns:

true if the given gradebook column record Type is supported, false otherwise

Throws:

NullArgumentException - gradebookColumnRecordType is null

Compliance:

mandatory - This method must be implemented.

getGradebookColumnSearchRecordTypes

TypeList getGradebookColumnSearchRecordTypes()

Gets the supported gradebook column search record types.

Returns:

a list containing the supported GradebookColumn search record types

Compliance:

mandatory - This method must be implemented.

supportsGradebookColumnSearchRecordType

boolean supportsGradebookColumnSearchRecordType(Type gradebookColumnSearchRecordType)

Tests if the given gradebook column search record type is supported.

Parameters:

gradebookColumnSearchRecordType - a Type indicating a GradebookColumn search record type

Returns:

true if the given search record Type is supported, false otherwise

Throws:

NullArgumentException - gradebookColumnSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getGradebookColumnSummaryRecordTypes

TypeList getGradebookColumnSummaryRecordTypes()

Gets the supported GradebookColumnSummary record types.

Returns:

a list containing the supported GradebookColumnSummary record types

Compliance:

mandatory - This method must be implemented.

supportsGradebookColumnSummaryRecordType

boolean supportsGradebookColumnSummaryRecordType(Type gradebookColumnSummaryRecordType)

Tests if the given GradebookColumnSummary record type is supported.

Parameters:

gradebookColumnSummaryRecordType - a Type indicating a GradebookColumnSummary type

Returns:

true if the given gradebook column summary record Type is supported, false otherwise

Throws:

NullArgumentException - gradebookColumnRecordType is null

Compliance:

mandatory - This method must be implemented.

getGradebookRecordTypes

TypeList getGradebookRecordTypes()

Gets the supported Gradebook record types.

Returns:

a list containing the supported Gradebook record types

Compliance:

mandatory - This method must be implemented.

supportsGradebookRecordType

boolean supportsGradebookRecordType(Type gradebookRecordType)

Tests if the given Gradebook record type is supported.

Parameters:

gradebookRecordType - a Type indicating a Gradebook type

Returns:

true if the given gradebook record Type is supported, false otherwise

Throws:

NullArgumentException - gradebookRecordType is null

Compliance:

mandatory - This method must be implemented.

getGradebookSearchRecordTypes

TypeList getGradebookSearchRecordTypes()

Gets the supported gradebook search record types.

Returns:

a list containing the supported Gradebook search record types

Compliance:

mandatory - This method must be implemented.

supportsGradebookSearchRecordType

boolean supportsGradebookSearchRecordType(Type gradebookSearchRecordType)

Tests if the given gradebook search record type is supported.

Parameters:

gradebookSearchRecordType - a Type indicating a Gradebook search record type

Returns:

true if the given search record Type is supported, false otherwise

Throws:

NullArgumentException - gradebookSearchRecordType is null

Compliance:

mandatory - This method must be implemented.