Interface LearningProfile
- All Superinterfaces:
OsidProfile, Sourceable
- All Known Subinterfaces:
LearningManager, LearningProxyManager
The LearningProfile describes the interoperability among
learning services.
-
Method Summary
Modifier and TypeMethodDescriptionGets the supportedActivityrecord types.Gets the supportedActivitysearch record types.Gets the supportedObjectiveBankrecord types.Gets the supported objective bank search record types.Gets the supportedObjectiverecord types.Gets the supportedObjectivesearch record types.Gets the supportedProficiencyrecord types.Gets the supportedProficiencysearch types.booleanTests if an activity administrative service is supported.booleanTests if an activity lookup service is supported.booleanTests if activity notification is supported.booleanTests if an activity to objective bank lookup session is available.booleanTests if an activity to objective bank assignment session is available.booleanTests if an activity query service is supported.booleansupportsActivityRecordType(Type activityRecordType) Tests if the givenActivityrecord type is supported.booleanTests if an activity search service is supported.booleansupportsActivitySearchRecordType(Type activitySearchRecordType) Tests if the givenActivitysearch record type is supported.booleanTests if an activity smart objective bank cataloging service is supported.booleanTests if a learning batch service is supported.booleanTests if a learning path service is supported.booleanTests if a learning path service is supported for the authenticated agent.booleanTests if an objective administrative service is supported.booleanTests if an objective bank administrative service is supported.booleanTests if an objective bank hierarchy traversal is supported.booleanTests if objective bank hierarchy design is supported.booleanTests if an objective bank lookup service is supported.booleanTests if objective bank notification is supported.booleanTests if an objective bank query service is supported.booleansupportsObjectiveBankRecordType(Type objectiveBankRecordType) Tests if the givenObjectiveBankrecord type is supported.booleanTests if an objective bank search service is supported.booleansupportsObjectiveBankSearchRecordType(Type objectiveBankSearchRecordType) Tests if the given objective bank search record type is supported.booleanTests if an objective hierarchy traversal is supported.booleanTests if an objective hierarchy design is supported.booleanTests if an objective lookup service is supported.booleanTests if objective notification is supported.booleanTests if an objective to objective bank lookup session is available.booleanTests if an objective to objective bank assignment session is available.booleanTests if an objective query service is supported.booleansupportsObjectiveRecordType(Type objectiveRecordType) Tests if the givenObjectiverecord type is supported.booleanTests if an objective requisite service is supported.booleanTests if an objective requisite assignment service is supported.booleanTests if an objective search service is supported.booleansupportsObjectiveSearchRecordType(Type objectiveSearchRecordType) Tests if the givenObjectivesearch record type is supported.booleanTests if an objective sequencing design is supported.booleanTests if an objective smart objective bank cataloging service is supported.booleanTests if proficiency administrative service is supported.booleanTests if looking up proficiencies is supported.booleanTests if a proficiency notification service is supported.booleanTests if a proficiency objective bank mapping lookup service is supported.booleanTests if a proficiency objective bank mapping service is supported.booleanTests if querying proficiencies is supported.booleansupportsProficiencyRecordType(Type proficiencyRecordType) Tests if the givenProficiencyrecord type is supported.booleanTests if searching proficiencies is supported.booleansupportsProficiencySearchRecordType(Type proficiencySearchRecordType) Tests if the givenProficiencysearch type is supported.booleanTests if a proficiency smart objective bank cataloging service is supported.booleanTests if federation is visible.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
supportsVisibleFederation
boolean supportsVisibleFederation()Tests if federation is visible.- Returns:
trueif visible federation is supported,falseotherwise- 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:
trueif objective query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveSearch
boolean supportsObjectiveSearch()Tests if an objective search service is supported.- Returns:
trueif objective search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveAdmin
boolean supportsObjectiveAdmin()Tests if an objective administrative service is supported.- Returns:
trueif objective admin is supported,falseotherwise- 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:
trueif objective notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveHierarchy
boolean supportsObjectiveHierarchy()Tests if an objective hierarchy traversal is supported.- Returns:
trueif an objective hierarchy traversal is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveHierarchyDesign
boolean supportsObjectiveHierarchyDesign()Tests if an objective hierarchy design is supported.- Returns:
trueif an objective hierarchy design is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveSequencing
boolean supportsObjectiveSequencing()Tests if an objective sequencing design is supported.- Returns:
trueif objective sequencing is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveObjectiveBank
boolean supportsObjectiveObjectiveBank()Tests if an objective to objective bank lookup session is available.- Returns:
trueif objective objective bank lookup session is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveObjectiveBankAssignment
boolean supportsObjectiveObjectiveBankAssignment()Tests if an objective to objective bank assignment session is available.- Returns:
trueif objective objective bank assignment is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveSmartObjectiveBank
boolean supportsObjectiveSmartObjectiveBank()Tests if an objective smart objective bank cataloging service is supported.- Returns:
trueif objective smart objective banks are supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveRequisite
boolean supportsObjectiveRequisite()Tests if an objective requisite service is supported.- Returns:
trueif objective requisite service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveRequisiteAssignment
boolean supportsObjectiveRequisiteAssignment()Tests if an objective requisite assignment service is supported.- Returns:
trueif objective requisite assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsActivityLookup
boolean supportsActivityLookup()Tests if an activity lookup service is supported.- Returns:
trueif activity lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsActivityQuery
boolean supportsActivityQuery()Tests if an activity query service is supported.- Returns:
trueif activity query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsActivitySearch
boolean supportsActivitySearch()Tests if an activity search service is supported.- Returns:
trueif activity search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsActivityAdmin
boolean supportsActivityAdmin()Tests if an activity administrative service is supported.- Returns:
trueif activity admin is supported,falseotherwise- 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:
trueif activity notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsActivityObjectiveBank
boolean supportsActivityObjectiveBank()Tests if an activity to objective bank lookup session is available.- Returns:
trueif activity objective bank lookup session is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsActivityObjectiveBankAssignment
boolean supportsActivityObjectiveBankAssignment()Tests if an activity to objective bank assignment session is available.- Returns:
trueif activity objective bank assignment is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsActivitySmartObjectiveBank
boolean supportsActivitySmartObjectiveBank()Tests if an activity smart objective bank cataloging service is supported.- Returns:
trueif activity smart objective banks are supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsProficiencyLookup
boolean supportsProficiencyLookup()Tests if looking up proficiencies is supported.- Returns:
trueif proficiency lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsProficiencyQuery
boolean supportsProficiencyQuery()Tests if querying proficiencies is supported.- Returns:
trueif proficiency query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsProficiencySearch
boolean supportsProficiencySearch()Tests if searching proficiencies is supported.- Returns:
trueif proficiency search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsProficiencyAdmin
boolean supportsProficiencyAdmin()Tests if proficiency administrative service is supported.- Returns:
trueif proficiency administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsProficiencyNotification
boolean supportsProficiencyNotification()Tests if a proficiency notification service is supported.- Returns:
trueif proficiency notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsProficiencyObjectiveBank
boolean supportsProficiencyObjectiveBank()Tests if a proficiency objective bank mapping lookup service is supported.- Returns:
trueif a proficiency objective bank lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsProficiencyObjectiveBankAssignment
boolean supportsProficiencyObjectiveBankAssignment()Tests if a proficiency objective bank mapping service is supported.- Returns:
trueif proficiency to objective bank mapping service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsProficiencySmartObjectiveBank
boolean supportsProficiencySmartObjectiveBank()Tests if a proficiency smart objective bank cataloging service is supported.- Returns:
trueif proficiency smart objective banks are supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsMyLearningPath
boolean supportsMyLearningPath()Tests if a learning path service is supported for the authenticated agent.- Returns:
trueif learning path is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsLearningPath
boolean supportsLearningPath()Tests if a learning path service is supported.- Returns:
trueif learning path is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveBankLookup
boolean supportsObjectiveBankLookup()Tests if an objective bank lookup service is supported.- Returns:
trueif objective bank lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveBankQuery
boolean supportsObjectiveBankQuery()Tests if an objective bank query service is supported.- Returns:
trueif objective bank query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveBankSearch
boolean supportsObjectiveBankSearch()Tests if an objective bank search service is supported.- Returns:
trueif objective bank search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveBankAdmin
boolean supportsObjectiveBankAdmin()Tests if an objective bank administrative service is supported.- Returns:
trueif objective bank admin is supported,falseotherwise- 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:
trueif objective bank notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveBankHierarchy
boolean supportsObjectiveBankHierarchy()Tests if an objective bank hierarchy traversal is supported.- Returns:
trueif an objective bank hierarchy traversal is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveBankHierarchyDesign
boolean supportsObjectiveBankHierarchyDesign()Tests if objective bank hierarchy design is supported.- Returns:
trueif an objective bank hierarchy design is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsLearningBatch
boolean supportsLearningBatch()Tests if a learning batch service is supported.- Returns:
trueif a learning batch service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getObjectiveRecordTypes
TypeList getObjectiveRecordTypes()Gets the supportedObjectiverecord types.- Returns:
- a list containing the supported
Objectiverecord types - Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveRecordType
Tests if the givenObjectiverecord type is supported.- Parameters:
objectiveRecordType- aTypeindicating anObjectiverecord type- Returns:
trueif the given Type is supported,falseotherwise- Throws:
NullArgumentException-objectiveRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getObjectiveSearchRecordTypes
TypeList getObjectiveSearchRecordTypes()Gets the supportedObjectivesearch record types.- Returns:
- a list containing the supported
Objectivesearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveSearchRecordType
Tests if the givenObjectivesearch record type is supported.- Parameters:
objectiveSearchRecordType- aTypeindicating anObjectivesearch record type- Returns:
trueif the given Type is supported,falseotherwise- Throws:
NullArgumentException-objectiveSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getActivityRecordTypes
TypeList getActivityRecordTypes()Gets the supportedActivityrecord types.- Returns:
- a list containing the supported
Activityrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsActivityRecordType
Tests if the givenActivityrecord type is supported.- Parameters:
activityRecordType- aTypeindicating aActivityrecord type- Returns:
trueif the given Type is supported,falseotherwise- Throws:
NullArgumentException-activityRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getActivitySearchRecordTypes
TypeList getActivitySearchRecordTypes()Gets the supportedActivitysearch record types.- Returns:
- a list containing the supported
Activitysearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsActivitySearchRecordType
Tests if the givenActivitysearch record type is supported.- Parameters:
activitySearchRecordType- aTypeindicating aActivitysearch record type- Returns:
trueif the given Type is supported,falseotherwise- Throws:
NullArgumentException-activitySearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getProficiencyRecordTypes
TypeList getProficiencyRecordTypes()Gets the supportedProficiencyrecord types.- Returns:
- a list containing the supported
Proficiencyrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsProficiencyRecordType
Tests if the givenProficiencyrecord type is supported.- Parameters:
proficiencyRecordType- aTypeindicating aProficiencyrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-proficiencyRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getProficiencySearchRecordTypes
TypeList getProficiencySearchRecordTypes()Gets the supportedProficiencysearch types.- Returns:
- a list containing the supported
Proficiencysearch types - Compliance:
mandatory- This method must be implemented.
-
supportsProficiencySearchRecordType
Tests if the givenProficiencysearch type is supported.- Parameters:
proficiencySearchRecordType- aTypeindicating aProficiencysearch type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-proficiencySearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getObjectiveBankRecordTypes
TypeList getObjectiveBankRecordTypes()Gets the supportedObjectiveBankrecord types.- Returns:
- a list containing the supported
ObjectiveBankrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveBankRecordType
Tests if the givenObjectiveBankrecord type is supported.- Parameters:
objectiveBankRecordType- aTypeindicating anObjectiveBanktype- Returns:
trueif the given objective bank recordTypeis supported,falseotherwise- Throws:
NullArgumentException-objectiveBankRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getObjectiveBankSearchRecordTypes
TypeList getObjectiveBankSearchRecordTypes()Gets the supported objective bank search record types.- Returns:
- a list containing the supported
ObjectiveBanksearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsObjectiveBankSearchRecordType
Tests if the given objective bank search record type is supported.- Parameters:
objectiveBankSearchRecordType- aTypeindicating anObjectiveBanksearch record type- Returns:
trueif the given search recordTypeis supported,falseotherwise- Throws:
NullArgumentException-objectiveBankSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-