Interface LearningManager

All Superinterfaces:

AutoCloseable, Closeable, LearningProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface LearningManager
extends OsidManager, LearningProfile

The learning manager provides access to learning sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• ObjectiveLookupSession: a session to look up objectives
• ObjectiveLookupSession: a session to query objectives
• ObjectiveSearchSession: a session to search objectives
• ObjectiveAdminSession: a session to create, modify and delete objectives
• ObjectiveNotificationSession: a session to receive messages pertaining to objective changes
• ObjectiveHierarchySession: a session to traverse objective hierarchies
• ObjectiveHierarchyDesignSession: a session to design objective hierarchies
• ObjectiveSequencingSession: a session to sequence objectives
• ObjectiveObjectiveBankSession: a session for retriieving objective and objective bank mappings
• ObjectiveObjectiveBankAssignmentSession: a session for managing objective and objective bank mappings
• ObjectiveSmartObjectiveBankSession: a session for managing dynamic objective banks
• ObjectiveRequisiteSession: a session to examine objective requisites
• ObjectiveRequisiteAssignmentSession: a session to manage objective requisites

• ActivityLookupSession: a session to look up activities
• ActivityQuerySession: a session to query activities
• ActivitySearchSession: a session to search activities
• ActivityAdminSession: a session to create, modify and delete activities
• ActivityNotificationSession: a session to receive messages pertaining to activity changes
• ActivityObjectiveBankSession: a session for retriieving activity and objective bank mappings
• ActivityObjectiveBankAssignmentSession: a session for managing activity and objective bank mappings
• ActivitySmartObjectiveBankSession: a session for managing dynamic objective banks of activities

• ProficiencyLookupSession: a session to retrieve proficiencies
• ProficiencyQuerySession: a session to query proficiencies
• ProficiencySearchSession: a session to search for proficiencies
• ProficiencyAdminSession: a session to create, update, and delete proficiencies
• ProficiencyNotificationSession: a session to receive notifications pertaining to proficiency changes
• ProficiencyObjectiveBankSession: a session to look up proficiency to objective bank mappings
• ProficiencyObjectiveBankAssignmentSession: a session to manage proficiency to objective bank mappings
• ProficiencySmartObjectiveBankSession: a session to manage smart objective banks of proficiencies
• MyLearningPathSession: a session to examine learning paths of objectives
• LearningPathSession: a session to examine learning paths of objectives

• ObjectiveBankLookupSession: a session to lookup objective banks
• ObjectiveBankQuerySession: a session to query objective banks
• ObjectiveBankSearchSession: a session to search objective banks
• ObjectiveBankAdminSession: a session to create, modify and delete objective banks
• ObjectiveBankNotificationSession: a session to receive messages pertaining to objective bank changes
• ObjectiveBankHierarchySession: a session to traverse the objective bank hierarchy
• ObjectiveBankHierarchyDesignSession: a session to manage the objective bank hierarchy

LearningManager may be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
ActivityAdminSession	getActivityAdminSession()	Gets the OsidSession associated with the activity administration service.
ActivityAdminSession	getActivityAdminSessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the activity admin service for the given objective bank.
ActivityLookupSession	getActivityLookupSession()	Gets the OsidSession associated with the activity lookup service.
ActivityLookupSession	getActivityLookupSessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the activity lookup service for the given objective bank.
ActivityNotificationSession	getActivityNotificationSession(ActivityReceiver activityReceiver)	Gets the notification session for notifications pertaining to activity changes.
ActivityNotificationSession	getActivityNotificationSessionForObjectiveBank(ActivityReceiver activityReceiver, Id objectiveBankId)	Gets the OsidSession associated with the activity notification service for the given objective bank.
ActivityObjectiveBankAssignmentSession	getActivityObjectiveBankAssignmentSession()	Gets the session for assigning activity to objective bank mappings.
ActivityObjectiveBankSession	getActivityObjectiveBankSession()	Gets the session for retrieving activity to objective bank mappings.
ActivityQuerySession	getActivityQuerySession()	Gets the OsidSession associated with the activity query service.
ActivityQuerySession	getActivityQuerySessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the activity query service for the given objective bank.
ActivitySearchSession	getActivitySearchSession()	Gets the OsidSession associated with the activity search service.
ActivitySearchSession	getActivitySearchSessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the activity search service for the given objective bank.
ActivitySmartObjectiveBankSession	getActivitySmartObjectiveBankSession(Id objectiveBankId)	Gets the OsidSession to manage dynamic objective banks of activities.
LearningBatchManager	getLearningBatchManager()	Gets a LearningBatchManager.
LearningPathSession	getLearningPathSession()	Gets the OsidSession associated with the learning path service.
LearningPathSession	getLearningPathSessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the learning path service for the given objective bank.
MyLearningPathSession	getMyLearningPathSession()	Gets the OsidSession associated with the my learning path service.
MyLearningPathSession	getMyLearningPathSessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the my learning path service for the given objective bank.
ObjectiveAdminSession	getObjectiveAdminSession()	Gets the OsidSession associated with the objective administration service.
ObjectiveAdminSession	getObjectiveAdminSessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the objective admin service for the given objective bank.
ObjectiveBankAdminSession	getObjectiveBankAdminSession()	Gets the OsidSession associated with the objective bank administration service.
ObjectiveBankHierarchyDesignSession	getObjectiveBankHierarchyDesignSession()	Gets the session designing objective bank hierarchies.
ObjectiveBankHierarchySession	getObjectiveBankHierarchySession()	Gets the session traversing objective bank hierarchies.
ObjectiveBankLookupSession	getObjectiveBankLookupSession()	Gets the OsidSession associated with the objective bank lookup service.
ObjectiveBankNotificationSession	getObjectiveBankNotificationSession(ObjectiveBankReceiver objectiveBankReceiver)	Gets the notification session for notifications pertaining to objective bank service changes.
ObjectiveBankQuerySession	getObjectiveBankQuerySession()	Gets the OsidSession associated with the objective bank query service.
ObjectiveBankSearchSession	getObjectiveBankSearchSession()	Gets the OsidSession associated with the objective bank search service.
ObjectiveHierarchyDesignSession	getObjectiveHierarchyDesignSession()	Gets the session for designing objective hierarchies.
ObjectiveHierarchyDesignSession	getObjectiveHierarchyDesignSessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the objective hierarchy design service for the given objective bank.
ObjectiveHierarchySession	getObjectiveHierarchySession()	Gets the session for traversing objective hierarchies.
ObjectiveHierarchySession	getObjectiveHierarchySessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the objective hierarchy traversal service for the given objective bank.
ObjectiveLookupSession	getObjectiveLookupSession()	Gets the OsidSession associated with the objective lookup service.
ObjectiveLookupSession	getObjectiveLookupSessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the objective lookup service for the given objective bank.
ObjectiveNotificationSession	getObjectiveNotificationSession(ObjectiveReceiver objectiveReceiver)	Gets the notification session for notifications pertaining to objective changes.
ObjectiveNotificationSession	getObjectiveNotificationSessionForObjectiveBank(ObjectiveReceiver objectiveReceiver, Id objectiveBankId)	Gets the OsidSession associated with the objective notification service for the given objective bank.
ObjectiveObjectiveBankAssignmentSession	getObjectiveObjectiveBankAssignmentSession()	Gets the session for assigning objective to objective bank mappings.
ObjectiveObjectiveBankSession	getObjectiveObjectiveBankSession()	Gets the session for retrieving objective to objective bank mappings.
ObjectiveQuerySession	getObjectiveQuerySession()	Gets the OsidSession associated with the objective query service.
ObjectiveQuerySession	getObjectiveQuerySessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the objective query service for the given objective bank.
ObjectiveRequisiteAssignmentSession	getObjectiveRequisiteAssignmentSession()	Gets the session for managing objective requisites.
ObjectiveRequisiteAssignmentSession	getObjectiveRequisiteAssignmentSessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the objective sequencing service for the given objective bank.
ObjectiveRequisiteSession	getObjectiveRequisiteSession()	Gets the session for examining objective requisites.
ObjectiveRequisiteSession	getObjectiveRequisiteSessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the objective sequencing service for the given objective bank.
ObjectiveSearchSession	getObjectiveSearchSession()	Gets the OsidSession associated with the objective search service.
ObjectiveSearchSession	getObjectiveSearchSessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the objective search service for the given objective bank.
ObjectiveSequencingSession	getObjectiveSequencingSession()	Gets the session for sequencing objectives.
ObjectiveSequencingSession	getObjectiveSequencingSessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the objective sequencing service for the given objective bank.
ObjectiveSmartObjectiveBankSession	getObjectiveSmartObjectiveBankSession(Id objectiveBankId)	Gets the OsidSession to manage dynamic objective banks of objectives.
ProficiencyAdminSession	getProficiencyAdminSession()	Gets the OsidSession associated with the proficiency administration service.
ProficiencyAdminSession	getProficiencyAdminSessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the proficiency administration service for the given objective bank.
ProficiencyLookupSession	getProficiencyLookupSession()	Gets the OsidSession associated with the proficiency lookup service.
ProficiencyLookupSession	getProficiencyLookupSessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the proficiency lookup service for the given objective bank.
ProficiencyNotificationSession	getProficiencyNotificationSession(ProficiencyReceiver proficiencyReceiver)	Gets the OsidSession associated with the proficiency notification service.
ProficiencyNotificationSession	getProficiencyNotificationSessionForObjectiveBank(ProficiencyReceiver proficiencyReceiver, Id objectiveBankId)	Gets the OsidSession associated with the proficiency notification service for the given objective bank.
ProficiencyObjectiveBankAssignmentSession	getProficiencyObjectiveBankAssignmentSession()	Gets the OsidSession associated with assigning proficiencys to objective banks.
ProficiencyObjectiveBankSession	getProficiencyObjectiveBankSession()	Gets the OsidSession to lookup proficiency/objective bank mappings.
ProficiencyQuerySession	getProficiencyQuerySession()	Gets the OsidSession associated with the proficiency query service.
ProficiencyQuerySession	getProficiencyQuerySessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the proficiency query service for the given objective bank.
ProficiencySearchSession	getProficiencySearchSession()	Gets the OsidSession associated with the proficiency search service.
ProficiencySearchSession	getProficiencySearchSessionForObjectiveBank(Id objectiveBankId)	Gets the OsidSession associated with the proficiency search service for the given objective bank.
ProficiencySmartObjectiveBankSession	getProficiencySmartObjectiveBankSession(Id objectiveBankId)	Gets the OsidSession to manage dynamic objective banks of objectives.

Methods inherited from interface Closeable

close

Methods inherited from interface LearningProfile

getActivityRecordTypes, getActivitySearchRecordTypes, getObjectiveBankRecordTypes, getObjectiveBankSearchRecordTypes, getObjectiveRecordTypes, getObjectiveSearchRecordTypes, getProficiencyRecordTypes, getProficiencySearchRecordTypes, supportsActivityAdmin, supportsActivityLookup, supportsActivityNotification, supportsActivityObjectiveBank, supportsActivityObjectiveBankAssignment, supportsActivityQuery, supportsActivityRecordType, supportsActivitySearch, supportsActivitySearchRecordType, supportsActivitySmartObjectiveBank, supportsLearningBatch, supportsLearningPath, supportsMyLearningPath, supportsObjectiveAdmin, supportsObjectiveBankAdmin, supportsObjectiveBankHierarchy, supportsObjectiveBankHierarchyDesign, supportsObjectiveBankLookup, supportsObjectiveBankNotification, supportsObjectiveBankQuery, supportsObjectiveBankRecordType, supportsObjectiveBankSearch, supportsObjectiveBankSearchRecordType, supportsObjectiveHierarchy, supportsObjectiveHierarchyDesign, supportsObjectiveLookup, supportsObjectiveNotification, supportsObjectiveObjectiveBank, supportsObjectiveObjectiveBankAssignment, supportsObjectiveQuery, supportsObjectiveRecordType, supportsObjectiveRequisite, supportsObjectiveRequisiteAssignment, supportsObjectiveSearch, supportsObjectiveSearchRecordType, supportsObjectiveSequencing, supportsObjectiveSmartObjectiveBank, supportsProficiencyAdmin, supportsProficiencyLookup, supportsProficiencyNotification, supportsProficiencyObjectiveBank, supportsProficiencyObjectiveBankAssignment, supportsProficiencyQuery, supportsProficiencyRecordType, supportsProficiencySearch, supportsProficiencySearchRecordType, supportsProficiencySmartObjectiveBank, supportsVisibleFederation

Methods inherited from interface OsidManager

close

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface OsidProfile

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

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Details

getObjectiveLookupSession

ObjectiveLookupSession getObjectiveLookupSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the objective lookup service.

Returns:

an ObjectiveLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveLookup()} is {@code true}.

getObjectiveLookupSessionForObjectiveBank

ObjectiveLookupSession getObjectiveLookupSessionForObjectiveBank(Id objectiveBankId)
                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the objective lookup service for the given objective bank.

Parameters:

objectiveBankId - the Id of the objective bank

Returns:

an ObjectiveLookupSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveLookup()} and {@code supportsVisibleFederation()} are {@code true}.

getObjectiveQuerySession

ObjectiveQuerySession getObjectiveQuerySession()
                                        throws OperationFailedException

Gets the OsidSession associated with the objective query service.

Returns:

an ObjectiveQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveQuery()} is {@code true}.

getObjectiveQuerySessionForObjectiveBank

ObjectiveQuerySession getObjectiveQuerySessionForObjectiveBank(Id objectiveBankId)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the objective query service for the given objective bank.

Parameters:

objectiveBankId - the Id of the objective bank

Returns:

an ObjectiveQuerySession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveQuery()} and {@code supportsVisibleFederation()} are {@code true}.

getObjectiveSearchSession

ObjectiveSearchSession getObjectiveSearchSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the objective search service.

Returns:

an ObjectiveSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveSearch()} is {@code true}.

getObjectiveSearchSessionForObjectiveBank

ObjectiveSearchSession getObjectiveSearchSessionForObjectiveBank(Id objectiveBankId)
                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the objective search service for the given objective bank.

Parameters:

objectiveBankId - the Id of the objective bank

Returns:

an ObjectiveSearchSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveSearch()} and {@code supportsVisibleFederation()} are {@code true}.

getObjectiveAdminSession

ObjectiveAdminSession getObjectiveAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the objective administration service.

Returns:

an ObjectiveAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveAdmin()} is {@code true}.

getObjectiveAdminSessionForObjectiveBank

ObjectiveAdminSession getObjectiveAdminSessionForObjectiveBank(Id objectiveBankId)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the objective admin service for the given objective bank.

Parameters:

objectiveBankId - the Id of the objective bank

Returns:

an ObjectiveAdminSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveAdmin()} and {@code supportsVisibleFederation()} are {@code true}.

getObjectiveNotificationSession

ObjectiveNotificationSession getObjectiveNotificationSession(ObjectiveReceiver objectiveReceiver)
                                                      throws OperationFailedException

Gets the notification session for notifications pertaining to objective changes.

Parameters:

objectiveReceiver - the objective receiver

Returns:

an ObjectiveNotificationSession

Throws:

NullArgumentException - objectiveReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveNotification()} is {@code true}.

getObjectiveNotificationSessionForObjectiveBank

ObjectiveNotificationSession getObjectiveNotificationSessionForObjectiveBank(ObjectiveReceiver objectiveReceiver,
 Id objectiveBankId)
                                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the objective notification service for the given objective bank.

Parameters:

objectiveReceiver - the objective receiver

objectiveBankId - the Id of the objective bank

Returns:

an ObjectiveNotificationSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveReceiver or objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveNotification()} and {@code supportsVisibleFederation()} are {@code true}.

getObjectiveHierarchySession

ObjectiveHierarchySession getObjectiveHierarchySession()
                                                throws OperationFailedException

Gets the session for traversing objective hierarchies.

Returns:

an ObjectiveHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveHierarchy()} is {@code true}.

getObjectiveHierarchySessionForObjectiveBank

ObjectiveHierarchySession getObjectiveHierarchySessionForObjectiveBank(Id objectiveBankId)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the objective hierarchy traversal service for the given objective bank.

Parameters:

objectiveBankId - the Id of the objective bank

Returns:

an ObjectiveHierarchySession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveHierarchy() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveHierarchy()} and {@code supportsVisibleFederation()} are {@code true}.

getObjectiveHierarchyDesignSession

ObjectiveHierarchyDesignSession getObjectiveHierarchyDesignSession()
                                                            throws OperationFailedException

Gets the session for designing objective hierarchies.

Returns:

an ObjectiveHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveHierarchyDesign()} is {@code true}.

getObjectiveHierarchyDesignSessionForObjectiveBank

ObjectiveHierarchyDesignSession getObjectiveHierarchyDesignSessionForObjectiveBank(Id objectiveBankId)
                                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the objective hierarchy design service for the given objective bank.

Parameters:

objectiveBankId - the Id of the objective bank

Returns:

an ObjectiveHierarchyDesignSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveHierarchyDesign() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveHierarchyDesign()} and {@code supportsVisibleFederation()} are {@code true}.

getObjectiveSequencingSession

ObjectiveSequencingSession getObjectiveSequencingSession()
                                                  throws OperationFailedException

Gets the session for sequencing objectives.

Returns:

an ObjectiveSequencingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveSequencing() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveSequencing()} is {@code true}.

getObjectiveSequencingSessionForObjectiveBank

ObjectiveSequencingSession getObjectiveSequencingSessionForObjectiveBank(Id objectiveBankId)
                                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the objective sequencing service for the given objective bank.

Parameters:

objectiveBankId - the Id of the objective bank

Returns:

an ObjectiveSequencingSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveSequencing() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveSequencing()} and {@code supportsVisibleFederation()} are {@code true}.

getObjectiveObjectiveBankSession

ObjectiveObjectiveBankSession getObjectiveObjectiveBankSession()
                                                        throws OperationFailedException

Gets the session for retrieving objective to objective bank mappings.

Returns:

an ObjectiveObjectiveBankSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveObjectiveBank() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveObjectiveBank()} is {@code true}.

getObjectiveObjectiveBankAssignmentSession

ObjectiveObjectiveBankAssignmentSession getObjectiveObjectiveBankAssignmentSession()
                                                                            throws OperationFailedException

Gets the session for assigning objective to objective bank mappings.

Returns:

an ObjectiveObjectiveBankAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveObjectiveBankAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveObjectiveBankAssignment()} is {@code true}.

getObjectiveSmartObjectiveBankSession

ObjectiveSmartObjectiveBankSession getObjectiveSmartObjectiveBankSession(Id objectiveBankId)
                                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage dynamic objective banks of objectives.

Parameters:

objectiveBankId - the Id of the ObjectiveBank

Returns:

an ObjectiveSmartObjectiveBankSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveSmartObjectiveBank() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveSmartObjectiveBank()} is {@code true}.

getObjectiveRequisiteSession

ObjectiveRequisiteSession getObjectiveRequisiteSession()
                                                throws OperationFailedException

Gets the session for examining objective requisites.

Returns:

an ObjectiveRequisiteSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveRequisite() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveRequisite()} is {@code true}.

getObjectiveRequisiteSessionForObjectiveBank

ObjectiveRequisiteSession getObjectiveRequisiteSessionForObjectiveBank(Id objectiveBankId)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the objective sequencing service for the given objective bank.

Parameters:

objectiveBankId - the Id of the objective bank

Returns:

an ObjectiveRequisiteSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveRequisite() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveRequisite()} and {@code supportsVisibleFederation()} are {@code true}.

getObjectiveRequisiteAssignmentSession

ObjectiveRequisiteAssignmentSession getObjectiveRequisiteAssignmentSession()
                                                                    throws OperationFailedException

Gets the session for managing objective requisites.

Returns:

an ObjectiveRequisiteAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveRequisiteAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveRequisiteAssignment()} is {@code true}.

getObjectiveRequisiteAssignmentSessionForObjectiveBank

ObjectiveRequisiteAssignmentSession getObjectiveRequisiteAssignmentSessionForObjectiveBank(Id objectiveBankId)
                                                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the objective sequencing service for the given objective bank.

Parameters:

objectiveBankId - the Id of the objective bank

Returns:

an ObjectiveRequisiteAssignmentSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveRequisiteAssignment() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveRequisiteAssignment()} and {@code supportsVisibleFederation()} are {@code true}.

getActivityLookupSession

ActivityLookupSession getActivityLookupSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the activity lookup service.

Returns:

an ActivityLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityLookup()} is {@code true}.

getActivityLookupSessionForObjectiveBank

ActivityLookupSession getActivityLookupSessionForObjectiveBank(Id objectiveBankId)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the activity lookup service for the given objective bank.

Parameters:

objectiveBankId - the Id of the objective bank

Returns:

an ActivityLookupSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityLookup()} and {@code supportsVisibleFederation()} are {@code true}.

getActivityQuerySession

ActivityQuerySession getActivityQuerySession()
                                      throws OperationFailedException

Gets the OsidSession associated with the activity query service.

Returns:

a ActivityQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityQuery()} is {@code true}.

getActivityQuerySessionForObjectiveBank

ActivityQuerySession getActivityQuerySessionForObjectiveBank(Id objectiveBankId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the activity query service for the given objective bank.

Parameters:

objectiveBankId - the Id of the objective bank

Returns:

an ActivityQuerySession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityQuery()} and {@code supportsVisibleFederation()} are {@code true}.

getActivitySearchSession

ActivitySearchSession getActivitySearchSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the activity search service.

Returns:

a ActivitySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivitySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsActivitySearch()} is {@code true}.

getActivitySearchSessionForObjectiveBank

ActivitySearchSession getActivitySearchSessionForObjectiveBank(Id objectiveBankId)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the activity search service for the given objective bank.

Parameters:

objectiveBankId - the Id of the objective bank

Returns:

an ActivitySearchSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivitySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivitySearch()} and {@code supportsVisibleFederation()} are {@code true}.

getActivityAdminSession

ActivityAdminSession getActivityAdminSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the activity administration service.

Returns:

a ActivityAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityAdmin()} is {@code true}.

getActivityAdminSessionForObjectiveBank

ActivityAdminSession getActivityAdminSessionForObjectiveBank(Id objectiveBankId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the activity admin service for the given objective bank.

Parameters:

objectiveBankId - the Id of the objective bank

Returns:

an ActivityAdminSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityAdmin()} and {@code supportsVisibleFederation()} are {@code true}.

getActivityNotificationSession

ActivityNotificationSession getActivityNotificationSession(ActivityReceiver activityReceiver)
                                                    throws OperationFailedException

Gets the notification session for notifications pertaining to activity changes.

Parameters:

activityReceiver - the activity receiver

Returns:

an ActivityNotificationSession

Throws:

NullArgumentException - activityReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityNotification()} is {@code true}.

getActivityNotificationSessionForObjectiveBank

ActivityNotificationSession getActivityNotificationSessionForObjectiveBank(ActivityReceiver activityReceiver,
 Id objectiveBankId)
                                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the activity notification service for the given objective bank.

Parameters:

activityReceiver - the activity receiver

objectiveBankId - the Id of the objective bank

Returns:

an ActivityNotificationSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - activityReceiver or objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityNotification()} and {@code supportsVisibleFederation()} are {@code true}.

getActivityObjectiveBankSession

ActivityObjectiveBankSession getActivityObjectiveBankSession()
                                                      throws OperationFailedException

Gets the session for retrieving activity to objective bank mappings.

Returns:

an ActivityObjectiveBankSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityObjectiveBank() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityObjectiveBank()} is {@code true}.

getActivityObjectiveBankAssignmentSession

ActivityObjectiveBankAssignmentSession getActivityObjectiveBankAssignmentSession()
                                                                          throws OperationFailedException

Gets the session for assigning activity to objective bank mappings.

Returns:

an ActivityObjectiveBankAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityObjectiveBankAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsActivityObjectiveBankAssignment()} is {@code true} .

getActivitySmartObjectiveBankSession

ActivitySmartObjectiveBankSession getActivitySmartObjectiveBankSession(Id objectiveBankId)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage dynamic objective banks of activities.

Parameters:

objectiveBankId - the Id of the ObjectiveBank

Returns:

an ActivitySmartObjectiveBankSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivitySmartObjectiveBank() is false

Compliance:

optional - This method must be implemented if {@code supportsActivitySmartObjectiveBank()} is {@code true}.

getProficiencyLookupSession

ProficiencyLookupSession getProficiencyLookupSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the proficiency lookup service.

Returns:

a ProficiencyLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencyLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProficiencyLookup()} is {@code true}.

getProficiencyLookupSessionForObjectiveBank

ProficiencyLookupSession getProficiencyLookupSessionForObjectiveBank(Id objectiveBankId)
                                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the proficiency lookup service for the given objective bank.

Parameters:

objectiveBankId - the Id of the obective bank

Returns:

a ProficiencyLookupSession

Throws:

NotFoundException - no ObjectiveBank found by the given Id

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencyLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProficiencyLookup()} and {@code supportsVisibleFederation()} are {@code true}

getProficiencyQuerySession

ProficiencyQuerySession getProficiencyQuerySession()
                                            throws OperationFailedException

Gets the OsidSession associated with the proficiency query service.

Returns:

a ProficiencyQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencyQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsProficiencyQuery()} is {@code true}.

getProficiencyQuerySessionForObjectiveBank

ProficiencyQuerySession getProficiencyQuerySessionForObjectiveBank(Id objectiveBankId)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the proficiency query service for the given objective bank.

Parameters:

objectiveBankId - the Id of the obective bank

Returns:

a ProficiencyQuerySession

Throws:

NotFoundException - no ObjectiveBank found by the given Id

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencyQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProficiencyQuery()} and {@code supportsVisibleFederation()} are {@code true}

getProficiencySearchSession

ProficiencySearchSession getProficiencySearchSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the proficiency search service.

Returns:

a ProficiencySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsProficiencySearch()} is {@code true}.

getProficiencySearchSessionForObjectiveBank

ProficiencySearchSession getProficiencySearchSessionForObjectiveBank(Id objectiveBankId)
                                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the proficiency search service for the given objective bank.

Parameters:

objectiveBankId - the Id of the ObjectiveBank

Returns:

a ProficiencySearchSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProficiencySearch()} and {@code supportsVisibleFederation()} are {@code true}

getProficiencyAdminSession

ProficiencyAdminSession getProficiencyAdminSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the proficiency administration service.

Returns:

a ProficiencyAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencyAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsProficiencyAdmin()} is {@code true}.

getProficiencyAdminSessionForObjectiveBank

ProficiencyAdminSession getProficiencyAdminSessionForObjectiveBank(Id objectiveBankId)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the proficiency administration service for the given objective bank.

Parameters:

objectiveBankId - the Id of the ObjectiveBank

Returns:

a ProficiencyAdminSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencyAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProficiencyAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getProficiencyNotificationSession

ProficiencyNotificationSession getProficiencyNotificationSession(ProficiencyReceiver proficiencyReceiver)
                                                          throws OperationFailedException

Gets the OsidSession associated with the proficiency notification service.

Parameters:

proficiencyReceiver - the notification callback

Returns:

a ProficiencyNotificationSession

Throws:

NullArgumentException - proficiencyReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencyNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsProficiencyNotification()} is {@code true}.

getProficiencyNotificationSessionForObjectiveBank

ProficiencyNotificationSession getProficiencyNotificationSessionForObjectiveBank(ProficiencyReceiver proficiencyReceiver,
 Id objectiveBankId)
                                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the proficiency notification service for the given objective bank.

Parameters:

proficiencyReceiver - the notification callback

objectiveBankId - the Id of the ObjectiveBank

Returns:

a ProficiencyNotificationSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - proficiencyReceiver or objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencyNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProficiencyNotification()} and {@code supportsVisibleFederation()} are {@code true}

getProficiencyObjectiveBankSession

ProficiencyObjectiveBankSession getProficiencyObjectiveBankSession()
                                                            throws OperationFailedException

Gets the OsidSession to lookup proficiency/objective bank mappings.

Returns:

a ProficiencyObjectiveBankSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencyObjectiveBank() is false

Compliance:

optional - This method must be implemented if {@code supportsProficiencyObjectiveBank()} is {@code true}.

getProficiencyObjectiveBankAssignmentSession

ProficiencyObjectiveBankAssignmentSession getProficiencyObjectiveBankAssignmentSession()
                                                                                throws OperationFailedException

Gets the OsidSession associated with assigning proficiencys to objective banks.

Returns:

a ProficiencyObjectiveBankAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencyObjectiveBankAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsProficiencyObjectiveBankAssignment()} is {@code true}.

getProficiencySmartObjectiveBankSession

ProficiencySmartObjectiveBankSession getProficiencySmartObjectiveBankSession(Id objectiveBankId)
                                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage dynamic objective banks of objectives.

Parameters:

objectiveBankId - the Id of the ObjectiveBank

Returns:

a ProficiencySmartObjectiveBankSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencySmartObjectiveBank() is false

Compliance:

optional - This method must be implemented if {@code supportsProficiencySmartObjectiveBank()} is {@code true}.

getMyLearningPathSession

MyLearningPathSession getMyLearningPathSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the my learning path service.

Returns:

a MyLearningPathSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMyLearningPath() is false

Compliance:

optional - This method must be implemented if {@code supportsMyLearningPath()} is {@code true}.

getMyLearningPathSessionForObjectiveBank

MyLearningPathSession getMyLearningPathSessionForObjectiveBank(Id objectiveBankId)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the my learning path service for the given objective bank.

Parameters:

objectiveBankId - the Id of the ObjectiveBank

Returns:

a MyLearningPathSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyLearningPath() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsMyLearningPath()} and {@code supportsVisibleFederation()} are {@code true}

getLearningPathSession

LearningPathSession getLearningPathSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the learning path service.

Returns:

a LearningPathSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLearningPath() is false

Compliance:

optional - This method must be implemented if {@code supportsLearningPath()} is {@code true}.

getLearningPathSessionForObjectiveBank

LearningPathSession getLearningPathSessionForObjectiveBank(Id objectiveBankId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the learning path service for the given objective bank.

Parameters:

objectiveBankId - the Id of the ObjectiveBank

Returns:

a LearningPathSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportyLearningPath() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsLearningPath()} and {@code supportsVisibleFederation()} are {@code true}

getObjectiveBankLookupSession

ObjectiveBankLookupSession getObjectiveBankLookupSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the objective bank lookup service.

Returns:

an ObjectiveBankLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBankLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveBankLookup()} is true.

getObjectiveBankQuerySession

ObjectiveBankQuerySession getObjectiveBankQuerySession()
                                                throws OperationFailedException

Gets the OsidSession associated with the objective bank query service.

Returns:

an ObjectiveBankQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBankQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveBankQuery()} is true.

getObjectiveBankSearchSession

ObjectiveBankSearchSession getObjectiveBankSearchSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the objective bank search service.

Returns:

an ObjectiveBankSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBankSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveBankSearch()} is true.

getObjectiveBankAdminSession

ObjectiveBankAdminSession getObjectiveBankAdminSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the objective bank administration service.

Returns:

an ObjectiveBankAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBankAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveBankAdmin()} is true.

getObjectiveBankNotificationSession

ObjectiveBankNotificationSession getObjectiveBankNotificationSession(ObjectiveBankReceiver objectiveBankReceiver)
                                                              throws OperationFailedException

Gets the notification session for notifications pertaining to objective bank service changes.

Parameters:

objectiveBankReceiver - the objective bank receiver

Returns:

an ObjectiveBankNotificationSession

Throws:

NullArgumentException - objectiveBankReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBankNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveBankNotification()} is true.

getObjectiveBankHierarchySession

ObjectiveBankHierarchySession getObjectiveBankHierarchySession()
                                                        throws OperationFailedException

Gets the session traversing objective bank hierarchies.

Returns:

an ObjectiveBankHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBankHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveBankHierarchy()} is true.

getObjectiveBankHierarchyDesignSession

ObjectiveBankHierarchyDesignSession getObjectiveBankHierarchyDesignSession()
                                                                    throws OperationFailedException

Gets the session designing objective bank hierarchies.

Returns:

an ObjectiveBankHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBankHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveBankHierarchyDesign()} is true.

getLearningBatchManager

LearningBatchManager getLearningBatchManager()
                                      throws OperationFailedException

Gets a LearningBatchManager.

Returns:

a LearningBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLearningBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsLearningBatch()} is true.