OSID - osid.grading.GradingProfile Service Interface Definition

Interface	osid.grading.GradingProfile
Implements	`osid.OsidProfile`
Implemented By	`osid.grading.GradingManager`
Implemented By	`osid.grading.GradingProxyManager`
Description	The `GradingProfile` describes the interoperability among grading services.
Method	supportsVisibleFederation
Description	Tests if federation is visible.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeLookup
Description	Tests if looking up grades is supported.
Return	`boolean`		`true` if grade lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeQuery
Description	Tests if querying grades is supported.
Return	`boolean`		`true` if grade query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeSearch
Description	Tests if searching grades is supported.
Return	`boolean`		`true` if grade search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeAdmin
Description	Tests if a grade administrative service is supported.
Return	`boolean`		`true` if grade administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeNotification
Description	Tests if a grade notification service is supported.
Return	`boolean`		`true` if grade notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeGradebook
Description	Tests if a grade gradebook lookup service is supported.
Return	`boolean`		`true` if a grade gradebook lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeGradebookAssignment
Description	Tests if a grade gradebook assignment service is supported.
Return	`boolean`		`true` if a grade to gradebook assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeSmartGradebook
Description	Tests if a grade smart gradebook service is supported.
Return	`boolean`		`true` if a smart gradebook service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeSystemLookup
Description	Tests if a grade system lookup service is supported.
Return	`boolean`		true if grade system lookup is supported, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeSystemQuery
Description	Tests if a grade system query service is supported.
Return	`boolean`		`true` if grade system query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeSystemSearch
Description	Tests if a grade system search service is supported.
Return	`boolean`		`true` if grade system search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeSystemAdmin
Description	Tests if a grade system administrative service is supported.
Return	`boolean`		`true` if grade system admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeSystemNotification
Description	Tests if grade system notification is supported. Messages may be sent when grade entries are created, modified, or deleted.
Return	`boolean`		`true` if grade system notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeSystemGradebook
Description	Tests if a grade system to gradebook lookup session is available.
Return	`boolean`		`true` if grade system gradebook lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeSystemGradebookAssignment
Description	Tests if a grade system to gradebook assignment session is available.
Return	`boolean`		`true` if grade system gradebook assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeSystemSmartGradebook
Description	Tests if a grade system smart gradebook session is available.
Return	`boolean`		`true` if grade system smart gradebook is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeEntryLookup
Description	Tests if a grade entry lookup service is supported.
Return	`boolean`		true if grade entry lookup is supported, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeEntryQuery
Description	Tests if a grade entry query service is supported.
Return	`boolean`		true if grade entry query is supported, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeEntrySearch
Description	Tests if a grade entry search service is supported.
Return	`boolean`		`true` if grade entry search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeEntryAdmin
Description	Tests if a grade entry administrative service is supported.
Return	`boolean`		`true` if grade entry admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeEntryNotification
Description	Tests if grade entry notification is supported.
Return	`boolean`		`true` if grade entry notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeEntryGradebook
Description	Tests if a grade entry to gradebook lookup session is available.
Return	`boolean`		`true` if grade entry gradebook lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeEntryGradebookAssignment
Description	Tests if a grade entry to gradebook assignment session is available.
Return	`boolean`		`true` if grade entry gradebook assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeEntrySmartGradebook
Description	Tests if a grade entry smart gradebook session is available.
Return	`boolean`		`true` if grade entry smart gradebook is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookColumnLookup
Description	Tests if a gradebook column lookup service is supported.
Return	`boolean`		true if gradebook column lookup is supported, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookColumnQuery
Description	Tests if a gradebook column query service is supported.
Return	`boolean`		`true` if gradebook column query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookColumnSearch
Description	Tests if a gradebook column search service is supported.
Return	`boolean`		`true` if gradebookc column search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookColumnAdmin
Description	Tests if a gradebook column administrative service is supported.
Return	`boolean`		`true` if gradebook column admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookColumnNotification
Description	Tests if gradebook column notification is supported. Messages may be sent when grade entries are created, modified, or deleted.
Return	`boolean`		`true` if gradebook column notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookColumnGradebook
Description	Tests if a gradebook column to gradebook lookup session is available.
Return	`boolean`		`true` if gradebook column gradebook lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookColumnGradebookAssignment
Description	Tests if a gradebook column to gradebook assignment session is available.
Return	`boolean`		`true` if gradebook column gradebook assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookColumnSmartGradebook
Description	Tests if a gradebook column smart gradebookt session is available.
Return	`boolean`		`true` if gradebook column amsrt gradebook is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookLookup
Description	Tests if a gradebook lookup service is supported.
Return	`boolean`		`true` if gradebook lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookQuery
Description	Tests if a gradebook query service is supported.
Return	`boolean`		`true` if gradebook query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookSearch
Description	Tests if a gradebook search service is supported.
Return	`boolean`		`true` if gradebook search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookAdmin
Description	Tests if a gradebook administrative service is supported.
Return	`boolean`		`true` if gradebook admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookNotification
Description	Tests if gradebook notification is supported. Messages may be sent when gradebooks are created, modified, or deleted.
Return	`boolean`		`true` if gradebook notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookHierarchy
Description	Tests if a gradebook hierarchy traversal is supported.
Return	`boolean`		`true` if a gradebook hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookHierarchyDesign
Description	Tests if gradebook hierarchy design is supported.
Return	`boolean`		`true` if a gradebook hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradingBatch
Description	Tests if a grading batch service is supported.
Return	`boolean`		`true` if a grading batch service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradingCalculation
Description	Tests if a grading calculation service is supported.
Return	`boolean`		`true` if a grading calculation service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradingTransform
Description	Tests if a grade system transform service is supported.
Return	`boolean`		`true` if a grading transform service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradeRecordTypes
Description	Gets the supported `Grade` record types.
Return	`osid.type.TypeList`		a list containing the supported `Grade` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeRecordType
Description	Tests if the given `Grade` record type is supported.
Parameters	`osid.type.Type`	`gradeRecordType`	a `Type` indicating a `Grade` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradeRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSearchRecordTypes
Description	Gets the supported `Grade` search types.
Return	`osid.type.TypeList`		a list containing the supported `Grade` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeSearchRecordType
Description	Tests if the given `Grade` search type is supported.
Parameters	`osid.type.Type`	`gradeSearchRecordType`	a `Type` indicating a `Grade` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradeSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemRecordTypes
Description	Gets the supported `GradeSystem` record types.
Return	`osid.type.TypeList`		a list containing the supported `GradeSystem` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeSystemRecordType
Description	Tests if the given `GradeSystem` record type is supported.
Parameters	`osid.type.Type`	`gradeSystemRecordType`	a `Type` indicating a `GradeSystem` record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradeSystemRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemSearchRecordTypes
Description	Gets the supported `GradeSystem` search record types.
Return	`osid.type.TypeList`		a list containing the supported `GradeSystem` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeSystemSearchRecordType
Description	Tests if the given `GradeSystem` search record type is supported.
Parameters	`osid.type.Type`	`gradeSystemSearchRecordType`	a `Type` indicating a `GradeSystem` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradeSystemSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntryRecordTypes
Description	Gets the supported `GradeEntry` record types.
Return	`osid.type.TypeList`		a list containing the supported `GradeEntry` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeEntryRecordType
Description	Tests if the given `GradeEntry` record type is supported.
Parameters	`osid.type.Type`	`gradeEntryRecordType`	a `Type` indicating a `GradeEntry` record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradeEntryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntrySearchRecordTypes
Description	Gets the supported `GradeEntry` search record types.
Return	`osid.type.TypeList`		a list containing the supported `GradeEntry` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeEntrySearchRecordType
Description	Tests if the given `GradeEntry` search record type is supported.
Parameters	`osid.type.Type`	`gradeEntrySearchRecordType`	a `Type` indicating a `GradeEntry` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradeEntrySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnRecordTypes
Description	Gets the supported `GradebookColumn` record types.
Return	`osid.type.TypeList`		a list containing the supported `GradebookColumn` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookColumnRecordType
Description	Tests if the given `GradebookColumn` record type is supported.
Parameters	`osid.type.Type`	`gradebookColumnRecordType`	a `Type` indicating a `GradebookColumn` type
Return	`boolean`		`true` if the given gradebook column record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradebookColumnRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnSearchRecordTypes
Description	Gets the supported gradebook column search record types.
Return	`osid.type.TypeList`		a list containing the supported `GradebookColumn` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookColumnSearchRecordType
Description	Tests if the given gradebook column search record type is supported.
Parameters	`osid.type.Type`	`gradebookColumnSearchRecordType`	a `Type` indicating a `GradebookColumn` search record type
Return	`boolean`		`true` if the given search record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradebookColumnSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnSummaryRecordTypes
Description	Gets the supported `GradebookColumnSummary` record types.
Return	`osid.type.TypeList`		a list containing the supported `GradebookColumnSummary` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookColumnSummaryRecordType
Description	Tests if the given `GradebookColumnSummary` record type is supported.
Parameters	`osid.type.Type`	`gradebookColumnSummaryRecordType`	a `Type` indicating a `GradebookColumnSummary` type
Return	`boolean`		`true` if the given gradebook column summary record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradebookColumnRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookRecordTypes
Description	Gets the supported `Gradebook` record types.
Return	`osid.type.TypeList`		a list containing the supported `Gradebook` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookRecordType
Description	Tests if the given `Gradebook` record type is supported.
Parameters	`osid.type.Type`	`gradebookRecordType`	a `Type` indicating a `Gradebook` type
Return	`boolean`		`true` if the given gradebook record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradebookRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookSearchRecordTypes
Description	Gets the supported gradebook search record types.
Return	`osid.type.TypeList`		a list containing the supported `Gradebook` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookSearchRecordType
Description	Tests if the given gradebook search record type is supported.
Parameters	`osid.type.Type`	`gradebookSearchRecordType`	a `Type` indicating a `Gradebook` search record type
Return	`boolean`		`true` if the given search record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`gradebookSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.