org.osid.learning.batch

Interface LearningBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, LearningBatchProfile, OsidManager, OsidProfile, Sourceable

public interface LearningBatchManager
extends OsidManager, LearningBatchProfile

The learning batch manager provides access to learning batch sessions and provides interoperability tests for various aspects of this service. 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

Methods

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

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.learning.batch.LearningBatchProfile

supportsActivityBatchAdmin, supportsObjectiveBankBatchAdmin, supportsObjectiveBatchAdmin, supportsProficiencyBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getObjectiveBatchAdminSession

ObjectiveBatchAdminSession getObjectiveBatchAdminSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk objective administration service.

Returns:

an ObjectiveBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsObjectiveBatchAdmin() is true.

getObjectiveBatchAdminSessionForObjectiveBank

ObjectiveBatchAdminSession getObjectiveBatchAdminSessionForObjectiveBank(Id objectiveBankId)
                                                                         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

Returns:

an ObjectiveBatchAdminSession

Throws:

NotFoundException - no ObjectiveBank found by the given Id

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsObjectiveBatchAdmin() and supportsVisibleFederation() are true

getActivityBatchAdminSession

ActivityBatchAdminSession getActivityBatchAdminSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk activity administration service.

Returns:

an ActivityBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsActivityBatchAdmin() is true.

getActivityBatchAdminSessionForObjectiveBank

ActivityBatchAdminSession getActivityBatchAdminSessionForObjectiveBank(Id objectiveBankId)
                                                                       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

Returns:

an ActivityBatchAdminSession

Throws:

NotFoundException - no ObjectiveBank found by the given Id

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActivityBatchAdmin() and supportsVisibleFederation() are true

getProficiencyBatchAdminSession

ProficiencyBatchAdminSession getProficiencyBatchAdminSession()
                                                             throws OperationFailedException

Gets the OsidSession associated with the bulk proficiency administration service.

Returns:

a ProficiencyBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencyBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsProficiencyBatchAdmin() is true.

getProficiencyBatchAdminSessionForObjectiveBank

ProficiencyBatchAdminSession getProficiencyBatchAdminSessionForObjectiveBank(Id objectiveBankId)
                                                                             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

Returns:

a ProficiencyBatchAdminSession

Throws:

NotFoundException - no ObjectiveBank found by the given Id

NullArgumentException - objectiveBankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProficiencyBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProficiencyBatchAdmin() and supportsVisibleFederation() are true

getObjectiveBankBatchAdminSession

ObjectiveBankBatchAdminSession getObjectiveBankBatchAdminSession()
                                                                 throws OperationFailedException

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

Returns:

an ObjectiveBankBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObjectiveBankBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsObjectiveBankBatchAdmin() is true.