org.osid.learning

Interface LearningProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

LearningManager, LearningProxyManager

public interface LearningProfile
extends OsidProfile

The LearningProfile describes the interoperability among learning services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getActivityRecordTypes() Gets the supported Activity record types.
TypeList	getActivitySearchRecordTypes() Gets the supported Activity search record types.
TypeList	getObjectiveBankRecordTypes() Gets the supported ObjectiveBank record types.
TypeList	getObjectiveBankSearchRecordTypes() Gets the supported objective bank search record types.
TypeList	getObjectiveRecordTypes() Gets the supported Objective record types.
TypeList	getObjectiveSearchRecordTypes() Gets the supported Objective search record types.
TypeList	getProficiencyRecordTypes() Gets the supported Proficiency record types.
TypeList	getProficiencySearchRecordTypes() Gets the supported Proficiency search types.
boolean	supportsActivityAdmin() Tests if an activity administrative service is supported.
boolean	supportsActivityLookup() Tests if an activity lookup service is supported.
boolean	supportsActivityNotification() Tests if activity notification is supported.
boolean	supportsActivityObjectiveBank() Tests if an activity to objective bank lookup session is available.
boolean	supportsActivityObjectiveBankAssignment() Tests if an activity to objective bank assignment session is available.
boolean	supportsActivityQuery() Tests if an activity query service is supported.
boolean	supportsActivityRecordType(Type activityRecordType) Tests if the given Activity record type is supported.
boolean	supportsActivitySearch() Tests if an activity search service is supported.
boolean	supportsActivitySearchRecordType(Type activitySearchRecordType) Tests if the given Activity search record type is supported.
boolean	supportsActivitySmartObjectiveBank() Tests if an activity smart objective bank cataloging service is supported.
boolean	supportsLearningBatch() Tests if a learning batch service is supported.
boolean	supportsLearningPath() Tests if a learning path service is supported.
boolean	supportsMyLearningPath() Tests if a learning path service is supported for the authenticated agent.
boolean	supportsObjectiveAdmin() Tests if an objective administrative service is supported.
boolean	supportsObjectiveBankAdmin() Tests if an objective bank administrative service is supported.
boolean	supportsObjectiveBankHierarchy() Tests if an objective bank hierarchy traversal is supported.
boolean	supportsObjectiveBankHierarchyDesign() Tests if objective bank hierarchy design is supported.
boolean	supportsObjectiveBankLookup() Tests if an objective bank lookup service is supported.
boolean	supportsObjectiveBankNotification() Tests if objective bank notification is supported.
boolean	supportsObjectiveBankQuery() Tests if an objective bank query service is supported.
boolean	supportsObjectiveBankRecordType(Type objectiveBankRecordType) Tests if the given ObjectiveBank record type is supported.
boolean	supportsObjectiveBankSearch() Tests if an objective bank search service is supported.
boolean	supportsObjectiveBankSearchRecordType(Type objectiveBankSearchRecordType) Tests if the given objective bank search record type is supported.
boolean	supportsObjectiveHierarchy() Tests if an objective hierarchy traversal is supported.
boolean	supportsObjectiveHierarchyDesign() Tests if an objective hierarchy design is supported.
boolean	supportsObjectiveLookup() Tests if an objective lookup service is supported.
boolean	supportsObjectiveNotification() Tests if objective notification is supported.
boolean	supportsObjectiveObjectiveBank() Tests if an objective to objective bank lookup session is available.
boolean	supportsObjectiveObjectiveBankAssignment() Tests if an objective to objective bank assignment session is available.
boolean	supportsObjectiveQuery() Tests if an objective query service is supported.
boolean	supportsObjectiveRecordType(Type objectiveRecordType) Tests if the given Objective record type is supported.
boolean	supportsObjectiveRequisite() Tests if an objective requisite service is supported.
boolean	supportsObjectiveRequisiteAssignment() Tests if an objective requisite assignment service is supported.
boolean	supportsObjectiveSearch() Tests if an objective search service is supported.
boolean	supportsObjectiveSearchRecordType(Type objectiveSearchRecordType) Tests if the given Objective search record type is supported.
boolean	supportsObjectiveSequencing() Tests if an objective sequencing design is supported.
boolean	supportsObjectiveSmartObjectiveBank() Tests if an objective smart objective bank cataloging service is supported.
boolean	supportsProficiencyAdmin() Tests if proficiency administrative service is supported.
boolean	supportsProficiencyLookup() Tests if looking up proficiencies is supported.
boolean	supportsProficiencyNotification() Tests if a proficiency notification service is supported.
boolean	supportsProficiencyObjectiveBank() Tests if a proficiency objective bank mapping lookup service is supported.
boolean	supportsProficiencyObjectiveBankAssignment() Tests if a proficiency objective bank mapping service is supported.
boolean	supportsProficiencyQuery() Tests if querying proficiencies is supported.
boolean	supportsProficiencyRecordType(Type proficiencyRecordType) Tests if the given Proficiency record type is supported.
boolean	supportsProficiencySearch() Tests if searching proficiencies is supported.
boolean	supportsProficiencySearchRecordType(Type proficiencySearchRecordType) Tests if the given Proficiency search type is supported.
boolean	supportsProficiencySmartObjectiveBank() Tests if a proficiency smart objective bank cataloging 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.

supportsObjectiveLookup

boolean supportsObjectiveLookup()

Tests if an objective lookup service is supported. An objective lookup service defines methods to access objectives.

Returns:

true if objective lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveQuery

boolean supportsObjectiveQuery()

Tests if an objective query service is supported.

Returns:

true if objective query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveSearch

boolean supportsObjectiveSearch()

Tests if an objective search service is supported.

Returns:

true if objective search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveAdmin

boolean supportsObjectiveAdmin()

Tests if an objective administrative service is supported.

Returns:

true if objective admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveNotification

boolean supportsObjectiveNotification()

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

Returns:

true if objective notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveHierarchy

boolean supportsObjectiveHierarchy()

Tests if an objective hierarchy traversal is supported.

Returns:

true if an objective hierarchy traversal is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveHierarchyDesign

boolean supportsObjectiveHierarchyDesign()

Tests if an objective hierarchy design is supported.

Returns:

true if an objective hierarchy design is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveSequencing

boolean supportsObjectiveSequencing()

Tests if an objective sequencing design is supported.

Returns:

true if objective sequencing is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveObjectiveBank

boolean supportsObjectiveObjectiveBank()

Tests if an objective to objective bank lookup session is available.

Returns:

true if objective objective bank lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveObjectiveBankAssignment

boolean supportsObjectiveObjectiveBankAssignment()

Tests if an objective to objective bank assignment session is available.

Returns:

true if objective objective bank assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveSmartObjectiveBank

boolean supportsObjectiveSmartObjectiveBank()

Tests if an objective smart objective bank cataloging service is supported.

Returns:

true if objective smart objective banks are supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveRequisite

boolean supportsObjectiveRequisite()

Tests if an objective requisite service is supported.

Returns:

true if objective requisite service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveRequisiteAssignment

boolean supportsObjectiveRequisiteAssignment()

Tests if an objective requisite assignment service is supported.

Returns:

true if objective requisite assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityLookup

boolean supportsActivityLookup()

Tests if an activity lookup service is supported.

Returns:

true if activity lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityQuery

boolean supportsActivityQuery()

Tests if an activity query service is supported.

Returns:

true if activity query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivitySearch

boolean supportsActivitySearch()

Tests if an activity search service is supported.

Returns:

true if activity search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityAdmin

boolean supportsActivityAdmin()

Tests if an activity administrative service is supported.

Returns:

true if activity admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityNotification

boolean supportsActivityNotification()

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

Returns:

true if activity notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityObjectiveBank

boolean supportsActivityObjectiveBank()

Tests if an activity to objective bank lookup session is available.

Returns:

true if activity objective bank lookup session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivityObjectiveBankAssignment

boolean supportsActivityObjectiveBankAssignment()

Tests if an activity to objective bank assignment session is available.

Returns:

true if activity objective bank assignment is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActivitySmartObjectiveBank

boolean supportsActivitySmartObjectiveBank()

Tests if an activity smart objective bank cataloging service is supported.

Returns:

true if activity smart objective banks are supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProficiencyLookup

boolean supportsProficiencyLookup()

Tests if looking up proficiencies is supported.

Returns:

true if proficiency lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProficiencyQuery

boolean supportsProficiencyQuery()

Tests if querying proficiencies is supported.

Returns:

true if proficiency query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProficiencySearch

boolean supportsProficiencySearch()

Tests if searching proficiencies is supported.

Returns:

true if proficiency search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProficiencyAdmin

boolean supportsProficiencyAdmin()

Tests if proficiency administrative service is supported.

Returns:

true if proficiency administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProficiencyNotification

boolean supportsProficiencyNotification()

Tests if a proficiency notification service is supported.

Returns:

true if proficiency notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProficiencyObjectiveBank

boolean supportsProficiencyObjectiveBank()

Tests if a proficiency objective bank mapping lookup service is supported.

Returns:

true if a proficiency objective bank lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProficiencyObjectiveBankAssignment

boolean supportsProficiencyObjectiveBankAssignment()

Tests if a proficiency objective bank mapping service is supported.

Returns:

true if proficiency to objective bank mapping service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsProficiencySmartObjectiveBank

boolean supportsProficiencySmartObjectiveBank()

Tests if a proficiency smart objective bank cataloging service is supported.

Returns:

true if proficiency smart objective banks are supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMyLearningPath

boolean supportsMyLearningPath()

Tests if a learning path service is supported for the authenticated agent.

Returns:

true if learning path is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLearningPath

boolean supportsLearningPath()

Tests if a learning path service is supported.

Returns:

true if learning path is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveBankLookup

boolean supportsObjectiveBankLookup()

Tests if an objective bank lookup service is supported.

Returns:

true if objective bank lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveBankQuery

boolean supportsObjectiveBankQuery()

Tests if an objective bank query service is supported.

Returns:

true if objective bank query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveBankSearch

boolean supportsObjectiveBankSearch()

Tests if an objective bank search service is supported.

Returns:

true if objective bank search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveBankAdmin

boolean supportsObjectiveBankAdmin()

Tests if an objective bank administrative service is supported.

Returns:

true if objective bank admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveBankNotification

boolean supportsObjectiveBankNotification()

Tests if objective bank notification is supported. Messages may be sent when objective banks are created, modified, or deleted.

Returns:

true if objective bank notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveBankHierarchy

boolean supportsObjectiveBankHierarchy()

Tests if an objective bank hierarchy traversal is supported.

Returns:

true if an objective bank hierarchy traversal is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsObjectiveBankHierarchyDesign

boolean supportsObjectiveBankHierarchyDesign()

Tests if objective bank hierarchy design is supported.

Returns:

true if an objective bank hierarchy design is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLearningBatch

boolean supportsLearningBatch()

Tests if a learning batch service is supported.

Returns:

true if a learning batch service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getObjectiveRecordTypes

TypeList getObjectiveRecordTypes()

Gets the supported Objective record types.

Returns:

a list containing the supported Objective record types

Compliance:

mandatory - This method must be implemented.

supportsObjectiveRecordType

boolean supportsObjectiveRecordType(Type objectiveRecordType)

Tests if the given Objective record type is supported.

Parameters:

objectiveRecordType - a Type indicating an Objective record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - objectiveRecordType is null

Compliance:

mandatory - This method must be implemented.

getObjectiveSearchRecordTypes

TypeList getObjectiveSearchRecordTypes()

Gets the supported Objective search record types.

Returns:

a list containing the supported Objective search record types

Compliance:

mandatory - This method must be implemented.

supportsObjectiveSearchRecordType

boolean supportsObjectiveSearchRecordType(Type objectiveSearchRecordType)

Tests if the given Objective search record type is supported.

Parameters:

objectiveSearchRecordType - a Type indicating an Objective search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - objectiveSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getActivityRecordTypes

TypeList getActivityRecordTypes()

Gets the supported Activity record types.

Returns:

a list containing the supported Activity record types

Compliance:

mandatory - This method must be implemented.

supportsActivityRecordType

boolean supportsActivityRecordType(Type activityRecordType)

Tests if the given Activity record type is supported.

Parameters:

activityRecordType - a Type indicating a Activity record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - activityRecordType is null

Compliance:

mandatory - This method must be implemented.

getActivitySearchRecordTypes

TypeList getActivitySearchRecordTypes()

Gets the supported Activity search record types.

Returns:

a list containing the supported Activity search record types

Compliance:

mandatory - This method must be implemented.

supportsActivitySearchRecordType

boolean supportsActivitySearchRecordType(Type activitySearchRecordType)

Tests if the given Activity search record type is supported.

Parameters:

activitySearchRecordType - a Type indicating a Activity search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - activitySearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getProficiencyRecordTypes

TypeList getProficiencyRecordTypes()

Gets the supported Proficiency record types.

Returns:

a list containing the supported Proficiency record types

Compliance:

mandatory - This method must be implemented.

supportsProficiencyRecordType

boolean supportsProficiencyRecordType(Type proficiencyRecordType)

Tests if the given Proficiency record type is supported.

Parameters:

proficiencyRecordType - a Type indicating a Proficiency record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - proficiencyRecordType is null

Compliance:

mandatory - This method must be implemented.

getProficiencySearchRecordTypes

TypeList getProficiencySearchRecordTypes()

Gets the supported Proficiency search types.

Returns:

a list containing the supported Proficiency search types

Compliance:

mandatory - This method must be implemented.

supportsProficiencySearchRecordType

boolean supportsProficiencySearchRecordType(Type proficiencySearchRecordType)

Tests if the given Proficiency search type is supported.

Parameters:

proficiencySearchRecordType - a Type indicating a Proficiency search type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - proficiencySearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getObjectiveBankRecordTypes

TypeList getObjectiveBankRecordTypes()

Gets the supported ObjectiveBank record types.

Returns:

a list containing the supported ObjectiveBank record types

Compliance:

mandatory - This method must be implemented.

supportsObjectiveBankRecordType

boolean supportsObjectiveBankRecordType(Type objectiveBankRecordType)

Tests if the given ObjectiveBank record type is supported.

Parameters:

objectiveBankRecordType - a Type indicating an ObjectiveBank type

Returns:

true if the given objective bank record Type is supported, false otherwise

Throws:

NullArgumentException - objectiveBankRecordType is null

Compliance:

mandatory - This method must be implemented.

getObjectiveBankSearchRecordTypes

TypeList getObjectiveBankSearchRecordTypes()

Gets the supported objective bank search record types.

Returns:

a list containing the supported ObjectiveBank search record types

Compliance:

mandatory - This method must be implemented.

supportsObjectiveBankSearchRecordType

boolean supportsObjectiveBankSearchRecordType(Type objectiveBankSearchRecordType)

Tests if the given objective bank search record type is supported.

Parameters:

objectiveBankSearchRecordType - a Type indicating an ObjectiveBank search record type

Returns:

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

Throws:

NullArgumentException - objectiveBankSearchRecordType is null

Compliance:

mandatory - This method must be implemented.