Interface LearningProxyManager

All Superinterfaces:

AutoCloseable, Closeable, LearningProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface LearningProxyManager
extends OsidProxyManager, LearningProfile

The learning manager provides access to learning sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy . 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

Method Summary

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

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

Modifier and Type	Method	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 OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getObjectiveLookupSession

ObjectiveLookupSession getObjectiveLookupSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the objective lookup service.

Parameters:

proxy - a proxy

Returns:

an ObjectiveLookupSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                          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

proxy - a proxy

Returns:

an ObjectiveLookupSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the objective query service.

Parameters:

proxy - a proxy

Returns:

an ObjectiveQuerySession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                        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

proxy - a proxy

Returns:

an ObjectiveQuerySession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the objective search service.

Parameters:

proxy - a proxy

Returns:

an ObjectiveSearchSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                          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

proxy - a proxy

Returns:

an ObjectiveSearchSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the objective administration service.

Parameters:

proxy - a proxy

Returns:

an ObjectiveAdminSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                        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

proxy - a proxy

Returns:

an ObjectiveAdminSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId or proxy 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,
 Proxy proxy)
                                                      throws OperationFailedException

Gets the notification session for notifications pertaining to objective changes.

Parameters:

objectiveReceiver - the objective receiver

proxy - a proxy

Returns:

an ObjectiveNotificationSession

Throws:

NullArgumentException - objectiveReceiver or proxy 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,
 Proxy proxy)
                                                                      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

proxy - a proxy

Returns:

an ObjectiveNotificationSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveReceiver, objectiveBankId or proxy 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(Proxy proxy)
                                                throws OperationFailedException

Gets the session for traversing objective hierarchies.

Parameters:

proxy - a proxy

Returns:

an ObjectiveHierarchySession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                                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

proxy - a proxy

Returns:

an ObjectiveHierarchySession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                                            throws OperationFailedException

Gets the session for designing objective hierarchies.

Parameters:

proxy - a proxy

Returns:

an ObjectiveHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                                            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

proxy - a proxy

Returns:

an ObjectiveHierarchyDesignSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                                  throws OperationFailedException

Gets the session for sequencing objectives.

Parameters:

proxy - a proxy

Returns:

an ObjectiveSequencingSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                                  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

proxy - a proxy

Returns:

an ObjectiveSequencingSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                                        throws OperationFailedException

Gets the session for retrieving objective to objective bank mappings.

Parameters:

proxy - a proxy

Returns:

an ObjectiveObjectiveBankSession

Throws:

NullArgumentException - proxy is null

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(Proxy proxy)
                                                                            throws OperationFailedException

Gets the session for assigning objective to objective bank mappings.

Parameters:

proxy - a proxy

Returns:

an ObjectiveObjectiveBankAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveObjectiveBankAssignment() is false

Compliance:

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

getObjectiveSmartObjectiveBankSession

ActivitySmartObjectiveBankSession getObjectiveSmartObjectiveBankSession(Id objectiveBankId,
 Proxy proxy)
                                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage dynamic objective banks of objectives.

Parameters:

objectiveBankId - the Id of the ObjectiveBank

proxy - a proxy

Returns:

an ObjectiveSmartObjectiveBankSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                                throws OperationFailedException

Gets the session for examining objective requisites.

Parameters:

proxy - a proxy

Returns:

an ObjectiveRequisiteSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                                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

proxy - a proxy

Returns:

an ObjectiveRequisiteSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                                                    throws OperationFailedException

Gets the session for managing objective requisites.

Parameters:

proxy - a proxy

Returns:

an ObjectiveRequisiteAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                                                    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

proxy - a proxy

Returns:

an ObjectiveRequisiteAssignmentSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the activity lookup service.

Parameters:

proxy - a proxy

Returns:

an ActivityLookupSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                        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

proxy - a proxy

Returns:

an ActivityLookupSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession associated with the activity query service.

Parameters:

proxy - a proxy

Returns:

an ActivityQuerySession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                      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

proxy - a proxy

Returns:

an ActivityQuerySession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the activity search service.

Parameters:

proxy - a proxy

Returns:

an ActivitySearchSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                        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

proxy - a proxy

Returns:

an ActivitySearchSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession associated with the activity administration service.

Parameters:

proxy - a proxy

Returns:

an ActivityAdminSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                      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

proxy - a proxy

Returns:

a ActivityAdminSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - objectiveBankId or proxy 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,
 Proxy proxy)
                                                    throws OperationFailedException

Gets the notification session for notifications pertaining to activity changes.

Parameters:

activityReceiver - the activity receiver

proxy - a proxy

Returns:

an ActivityNotificationSession

Throws:

NullArgumentException - activityReceiver or proxy 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,
 Proxy proxy)
                                                                    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

proxy - a proxy

Returns:

an ActivityNotificationSession

Throws:

NotFoundException - objectiveBankId not found

NullArgumentException - activityReceiver, objectiveBankId or proxy 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(Proxy proxy)
                                                      throws OperationFailedException

Gets the session for retrieving activity to objective bank mappings.

Parameters:

proxy - a proxy

Returns:

an ActivityObjectiveBankSession

Throws:

NullArgumentException - proxy is null

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(Proxy proxy)
                                                                          throws OperationFailedException

Gets the session for assigning activity to objective bank mappings.

Parameters:

proxy - a proxy

Returns:

an ActivityObjectiveBankAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage dynamic objective banks of activities.

Parameters:

objectiveBankId - the Id of the ObjectiveBank

proxy - a proxy

Returns:

an ActivitySmartObjectiveBankSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the proficiency lookup service.

Parameters:

proxy - a proxy

Returns:

a ProficiencyLookupSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                              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

proxy - a proxy

Returns:

a ProficiencyLookupSession

Throws:

NotFoundException - no ObjectiveBank found by the given Id

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the proficiency query service.

Parameters:

proxy - a proxy

Returns:

a ProficiencyQuerySession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                            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

proxy - a proxy

Returns:

a ProficiencyQuerySession

Throws:

NotFoundException - no ObjectiveBank found by the given Id

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the proficiency search service.

Parameters:

proxy - a proxy

Returns:

a ProficiencySearchSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                              throws NotFoundException,
OperationFailedException

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

Parameters:

objectiveBankId - the Id of the ObjectiveBank

proxy - a proxy

Returns:

a ProficiencySearchSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the proficiency administration service.

Parameters:

proxy - a proxy

Returns:

a ProficiencyAdminSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

objectiveBankId - the Id of the ObjectiveBank

proxy - a proxy

Returns:

a ProficiencyAdminSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - objectiveBankId or proxy 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,
 Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the proficiency notification service.

Parameters:

proficiencyReceiver - the notification callback

proxy - a proxy

Returns:

a ProficiencyNotificationSession

Throws:

NullArgumentException - proficiencyReceiver or proxy 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,
 Proxy proxy)
                                                                          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

proxy - a proxy

Returns:

a ProficiencyNotificationSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - proficiencyReceiver, objectiveBankId or proxy 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(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession to lookup proficiency/objective bank mappings.

Parameters:

proxy - a proxy

Returns:

a ProficiencyObjectiveBankSession

Throws:

NullArgumentException - proxy is null

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(Proxy proxy)
                                                                                throws OperationFailedException

Gets the OsidSession associated with assigning proficiencies to objective banks.

Parameters:

proxy - a proxy

Returns:

a ProficiencyObjectiveBankAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage dynamic objective banks of proficiencies.

Parameters:

objectiveBankId - the Id of the ObjectiveBank

proxy - a proxy

Returns:

a ProficiencySmartObjectiveBankSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the my learning path service.

Parameters:

proxy - a proxy

Returns:

a MyLearningPathSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                        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

proxy - a proxy

Returns:

a MyLearningPathSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the learning path service.

Parameters:

proxy - a proxy

Returns:

a LearningPathSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

objectiveBankId - the Id of the ObjectiveBank

proxy - a proxy

Returns:

a LearningPathSession

Throws:

NotFoundException - no objective bank found by the given Id

NullArgumentException - objectiveBankId or proxy 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(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the objective bank lookup service.

Parameters:

proxy - a proxy

Returns:

an ObjectiveBankLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBankLookup() is false

Compliance:

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

getObjectiveBankQuerySession

ObjectiveBankQuerySession getObjectiveBankQuerySession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the objective bank query service.

Parameters:

proxy - a proxy

Returns:

an ObjectiveBankQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBankQuery() is false

Compliance:

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

getObjectiveBankSearchSession

ObjectiveBankSearchSession getObjectiveBankSearchSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the objective bank search service.

Parameters:

proxy - a proxy

Returns:

an ObjectiveBankSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBankSearch() is false

Compliance:

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

getObjectiveBankAdminSession

ObjectiveBankAdminSession getObjectiveBankAdminSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the objective bank administration service.

Parameters:

proxy - a proxy

Returns:

an ObjectiveBankAdminSession

Throws:

NullArgumentException - proxy is null

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,
 Proxy proxy)
                                                              throws OperationFailedException

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

Parameters:

objectiveBankReceiver - the objective bank receiver

proxy - a proxy

Returns:

an ObjectiveBankNotificationSession

Throws:

NullArgumentException - objectiveBankReceiver or proxy 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(Proxy proxy)
                                                        throws OperationFailedException

Gets the session traversing objective bank hierarchies.

Parameters:

proxy - a proxy

Returns:

an ObjectiveBankHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBankHierarchy() is false

Compliance:

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

getObjectiveBankHierarchyDesignSession

ObjectiveBankHierarchyDesignSession getObjectiveBankHierarchyDesignSession(Proxy proxy)
                                                                    throws OperationFailedException

Gets the session designing objective bank hierarchies.

Parameters:

proxy - a proxy

Returns:

an ObjectiveBankHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBankHierarchyDesign() is false

Compliance:

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

getLearningBatchProxyManager

LearningBatchProxyManager getLearningBatchProxyManager()
                                                throws OperationFailedException

Gets a LearningBatchProxyManager .

Returns:

a LearningBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLearningBatch() is false

Compliance:

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