Interface LearningBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, LearningBatchProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface LearningBatchProxyManager
extends OsidProxyManager, LearningBatchProfile

The learning batch proxy manager provides access to learning batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

• ObjectiveBatchAdminSession: a session to create, modify and delete availabilities in bulk
• ActivityBatchAdminSession: a session to create, modify and delete activities in bulk
• ProficiencyBatchAdminSession: a session to create, modify and delete proficiencies in bulk
• ObjectiveBankBatchAdminSession: a session to create, modify and delete objective banks in bulk

Method Summary

Modifier and Type	Method	Description
ActivityBatchAdminSession	getActivityBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk activity administration service.
ActivityBatchAdminSession	getActivityBatchAdminSessionForObjectiveBank(Id objectiveBankId, Proxy proxy)	Gets the OsidSession associated with the bulk activity administration service for the given objective bank.
ObjectiveBankBatchAdminSession	getObjectiveBankBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk objective bank administration service.
ObjectiveBatchAdminSession	getObjectiveBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk objective administration service.
ObjectiveBatchAdminSession	getObjectiveBatchAdminSessionForObjectiveBank(Id objectiveBankId, Proxy proxy)	Gets the OsidSession associated with the bulk objective administration service for the given objective bank.
ProficiencyBatchAdminSession	getProficiencyBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk proficiency administration service.
ProficiencyBatchAdminSession	getProficiencyBatchAdminSessionForObjectiveBank(Id objectiveBankId, Proxy proxy)	Gets the OsidSession associated with the bulk proficiency administration service for the given objective bank.

Methods inherited from interface Closeable

close

Methods inherited from interface LearningBatchProfile

supportsActivityBatchAdmin, supportsObjectiveBankBatchAdmin, supportsObjectiveBatchAdmin, supportsProficiencyBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsActivityBatchAdmin()	Tests if bulk administration of activities is available.
boolean	supportsObjectiveBankBatchAdmin()	Tests if bulk administration of objective banks is available.
boolean	supportsObjectiveBatchAdmin()	Tests if bulk administration of availabilities is available.
boolean	supportsProficiencyBatchAdmin()	Tests if bulk administration of proficiencies is available.
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

getObjectiveBatchAdminSession

ObjectiveBatchAdminSession getObjectiveBatchAdminSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the bulk objective administration service.

Parameters:

proxy - a proxy

Returns:

an ObjectiveBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBatchAdmin() is false

Compliance:

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

getObjectiveBatchAdminSessionForObjectiveBank

ObjectiveBatchAdminSession getObjectiveBatchAdminSessionForObjectiveBank(Id objectiveBankId,
 Proxy proxy)
                                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

objectiveBankId - the Id of the ObjectiveBank

proxy - a proxy

Returns:

an ObjectiveBatchAdminSession

Throws:

NotFoundException - no ObjectiveBank found by the given Id

NullArgumentException - objectiveBankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getActivityBatchAdminSession

ActivityBatchAdminSession getActivityBatchAdminSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the bulk activity administration service.

Parameters:

proxy - a proxy

Returns:

an ActivityBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBatchAdmin() is false

Compliance:

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

getActivityBatchAdminSessionForObjectiveBank

ActivityBatchAdminSession getActivityBatchAdminSessionForObjectiveBank(Id objectiveBankId,
 Proxy proxy)
                                                                throws NotFoundException,
OperationFailedException

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

Parameters:

objectiveBankId - the Id of the ObjectiveBank

proxy - a proxy

Returns:

an ActivityBatchAdminSession

Throws:

NotFoundException - no ObjectiveBank found by the given Id

NullArgumentException - objectiveBankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getProficiencyBatchAdminSession

ProficiencyBatchAdminSession getProficiencyBatchAdminSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the bulk proficiency administration service.

Parameters:

proxy - a proxy

Returns:

a ProficiencyBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencyBatchAdmin() is false

Compliance:

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

getProficiencyBatchAdminSessionForObjectiveBank

ProficiencyBatchAdminSession getProficiencyBatchAdminSessionForObjectiveBank(Id objectiveBankId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

objectiveBankId - the Id of the ObjectiveBank

proxy - a proxy

Returns:

a ProficiencyBatchAdminSession

Throws:

NotFoundException - no ObjectiveBank found by the given Id

NullArgumentException - objectiveBankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencyBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getObjectiveBankBatchAdminSession

ObjectiveBankBatchAdminSession getObjectiveBankBatchAdminSession(Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the bulk objective bank administration service.

Parameters:

proxy - a proxy

Returns:

an ObjectiveBankBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBankBatchAdmin() is false

Compliance:

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