OSID - osid.learning.LearningProfile Service Interface Definition

Interface	osid.learning.LearningProfile
Implements	`osid.OsidProfile`
Description	The `LearningProfile` describes the interoperability among learning 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	supportsObjectiveLookup
Description	Tests if an objective lookup service is supported. An objective lookup service defines methods to access objectives.
Return	`boolean`		true if objective lookup is supported, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveQuery
Description	Tests if an objective query service is supported.
Return	`boolean`		`true` if objective query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveSearch
Description	Tests if an objective search service is supported.
Return	`boolean`		`true` if objective search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveAdmin
Description	Tests if an objective administrative service is supported.
Return	`boolean`		`true` if objective admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveNotification
Description	Tests if objective notification is supported. Messages may be sent when objectives are created, modified, or deleted.
Return	`boolean`		`true` if objective notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveHierarchy
Description	Tests if an objective hierarchy traversal is supported.
Return	`boolean`		`true` if an objective hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveHierarchyDesign
Description	Tests if an objective hierarchy design is supported.
Return	`boolean`		`true` if an objective hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveSequencing
Description	Tests if an objective sequencing design is supported.
Return	`boolean`		`true` if objective sequencing is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveObjectiveBank
Description	Tests if an objective to objective bank lookup session is available.
Return	`boolean`		`true` if objective objective bank lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveObjectiveBankAssignment
Description	Tests if an objective to objective bank assignment session is available.
Return	`boolean`		`true` if objective objective bank assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveSmartObjectiveBank
Description	Tests if an objective smart objective bank cataloging service is supported.
Return	`boolean`		`true` if objective smart objective banks are supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveRequisite
Description	Tests if an objective requisite service is supported.
Return	`boolean`		`true` if objective requisite service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveRequisiteAssignment
Description	Tests if an objective requisite assignment service is supported.
Return	`boolean`		`true` if objective requisite assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityLookup
Description	Tests if an activity lookup service is supported.
Return	`boolean`		`true` if activity lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityQuery
Description	Tests if an activity query service is supported.
Return	`boolean`		`true` if activity query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivitySearch
Description	Tests if an activity search service is supported.
Return	`boolean`		`true` if activity search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityAdmin
Description	Tests if an activity administrative service is supported.
Return	`boolean`		`true` if activity admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityNotification
Description	Tests if activity notification is supported. Messages may be sent when activities are created, modified, or deleted.
Return	`boolean`		`true` if activity notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityObjectiveBank
Description	Tests if an activity to objective bank lookup session is available.
Return	`boolean`		`true` if activity objective bank lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityObjectiveBankAssignment
Description	Tests if an activity to objective bank assignment session is available.
Return	`boolean`		`true` if activity objective bank assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivitySmartObjectiveBank
Description	Tests if an activity smart objective bank cataloging service is supported.
Return	`boolean`		`true` if activity smart objective banks are supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProficiencyLookup
Description	Tests if looking up proficiencies is supported.
Return	`boolean`		`true` if proficiency lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProficiencyQuery
Description	Tests if querying proficiencies is supported.
Return	`boolean`		`true` if proficiency query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProficiencySearch
Description	Tests if searching proficiencies is supported.
Return	`boolean`		`true` if proficiency search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProficiencyAdmin
Description	Tests if proficiency administrative service is supported.
Return	`boolean`		`true` if proficiency administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProficiencyNotification
Description	Tests if a proficiency notification service is supported.
Return	`boolean`		`true` if proficiency notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProficiencyObjectiveBank
Description	Tests if a proficiency objective bank mapping lookup service is supported.
Return	`boolean`		`true` if a proficiency objective bank lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProficiencyObjectiveBankAssignment
Description	Tests if a proficiency objective bank mapping service is supported.
Return	`boolean`		`true` if proficiency to objective bank mapping service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProficiencySmartObjectiveBank
Description	Tests if a proficiency smart objective bank cataloging service is supported.
Return	`boolean`		`true` if proficiency smart objective banks are supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMyLearningPath
Description	Tests if a learning path service is supported for the authenticated agent.
Return	`boolean`		`true` if learning path is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLearningPath
Description	Tests if a learning path service is supported.
Return	`boolean`		`true` if learning path is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveBankLookup
Description	Tests if an objective bank lookup service is supported.
Return	`boolean`		`true` if objective bank lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveBankQuery
Description	Tests if an objective bank query service is supported.
Return	`boolean`		`true` if objective bank query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveBankSearch
Description	Tests if an objective bank search service is supported.
Return	`boolean`		`true` if objective bank search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveBankAdmin
Description	Tests if an objective bank administrative service is supported.
Return	`boolean`		`true` if objective bank admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveBankNotification
Description	Tests if objective bank notification is supported. Messages may be sent when objective banks are created, modified, or deleted.
Return	`boolean`		`true` if objective bank notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveBankHierarchy
Description	Tests if an objective bank hierarchy traversal is supported.
Return	`boolean`		`true` if an objective bank hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveBankHierarchyDesign
Description	Tests if objective bank hierarchy design is supported.
Return	`boolean`		`true` if an objective bank hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLearningBatch
Description	Tests if a learning batch service is supported.
Return	`boolean`		`true` if a learning batch service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveRecordTypes
Description	Gets the supported `Objective` record types.
Return	`osid.type.TypeList`		a list containing the supported `Objective` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveRecordType
Description	Tests if the given `Objective` record type is supported.
Parameters	`osid.type.Type`	`objectiveRecordType`	a `Type` indicating an `Objective` record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`objectiveRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveSearchRecordTypes
Description	Gets the supported `Objective` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Objective` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveSearchRecordType
Description	Tests if the given `Objective` search record type is supported.
Parameters	`osid.type.Type`	`objectiveSearchRecordType`	a `Type` indicating an `Objective` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`objectiveSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRecordTypes
Description	Gets the supported `Activity` record types.
Return	`osid.type.TypeList`		a list containing the supported `Activity` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityRecordType
Description	Tests if the given `Activity` record type is supported.
Parameters	`osid.type.Type`	`activityRecordType`	a `Type` indicating a `Activity` record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`activityRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getActivitySearchRecordTypes
Description	Gets the supported `Activity` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Activity` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivitySearchRecordType
Description	Tests if the given `Activity` search record type is supported.
Parameters	`osid.type.Type`	`activitySearchRecordType`	a `Type` indicating a `Activity` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`activitySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProficiencyRecordTypes
Description	Gets the supported `Proficiency` record types.
Return	`osid.type.TypeList`		a list containing the supported `Proficiency` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProficiencyRecordType
Description	Tests if the given `Proficiency` record type is supported.
Parameters	`osid.type.Type`	`proficiencyRecordType`	a `Type` indicating a `Proficiency` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`proficiencyRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProficiencySearchRecordTypes
Description	Gets the supported `Proficiency` search types.
Return	`osid.type.TypeList`		a list containing the supported `Proficiency` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProficiencySearchRecordType
Description	Tests if the given `Proficiency` search type is supported.
Parameters	`osid.type.Type`	`proficiencySearchRecordType`	a `Type` indicating a `Proficiency` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`proficiencySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveBankRecordTypes
Description	Gets the supported `ObjectiveBank` record types.
Return	`osid.type.TypeList`		a list containing the supported `ObjectiveBank` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveBankRecordType
Description	Tests if the given `ObjectiveBank` record type is supported.
Parameters	`osid.type.Type`	`objectiveBankRecordType`	a `Type` indicating an `ObjectiveBank` type
Return	`boolean`		`true` if the given objective bank record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`objectiveBankRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveBankSearchRecordTypes
Description	Gets the supported objective bank search record types.
Return	`osid.type.TypeList`		a list containing the supported `ObjectiveBank` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsObjectiveBankSearchRecordType
Description	Tests if the given objective bank search record type is supported.
Parameters	`osid.type.Type`	`objectiveBankSearchRecordType`	a `Type` indicating an `ObjectiveBank` search record type
Return	`boolean`		`true` if the given search record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`objectiveBankSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.