org.osid.assessment.batch

Interface AssessmentBatchManager

All Superinterfaces:

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

public interface AssessmentBatchManager
extends OsidManager, AssessmentBatchProfile

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

• ItemBatchAdminSession: a session to create, modify and delete items in bulk
• AssessmentBatchAdminSession: a session to create, modify and delete assessments in bulk
• AssessmentOfferedBatchAdminSession: a session to create, modify and delete assessments offered in bulk
• AssessmentTakenBatchAdminSession: a session to create, modify and delete assessments taken in bulk
• BankBatchAdminSession: a session to create, modify and delete banks in bulk

Method Summary

Methods

Modifier and Type	Method and Description
AssessmentBatchAdminSession	getAssessmentBatchAdminSession() Gets the OsidSession associated with the bulk assessment administration service.
AssessmentBatchAdminSession	getAssessmentBatchAdminSessionForBank(Id bankId) Gets the OsidSession associated with the bulk assessment administration service for the given bank.
AssessmentOfferedBatchAdminSession	getAssessmentOfferedBatchAdminSession() Gets the OsidSession associated with the bulk assessment offered administration service.
AssessmentOfferedBatchAdminSession	getAssessmentOfferedBatchAdminSessionForBank(Id bankId) Gets the OsidSession associated with the bulk assessment offered administration service for the given bank.
AssessmentTakenBatchAdminSession	getAssessmentTakenBatchAdminSession() Gets the OsidSession associated with the bulk assessment taken administration service.
AssessmentTakenBatchAdminSession	getAssessmentTakenBatchAdminSessionForBank(Id bankId) Gets the OsidSession associated with the bulk assessment taken administration service for the given bank.
BankBatchAdminSession	getBankBatchAdminSession() Gets the OsidSession associated with the bulk bank administration service.
ItemBatchAdminSession	getItemBatchAdminSession() Gets the OsidSession associated with the bulk item administration service.
ItemBatchAdminSession	getItemBatchAdminSessionForBank(Id bankId) Gets the OsidSession associated with the bulk item administration service for the given 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.assessment.batch.AssessmentBatchProfile

supportsAssessmentBatchAdmin, supportsAssessmentOfferedBatchAdmin, supportsAssessmentTakenBatchAdmin, supportsBankBatchAdmin, supportsItemBatchAdmin, 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

getItemBatchAdminSession

ItemBatchAdminSession getItemBatchAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk item administration service.

Returns:

an ItemBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBatchAdmin() is false

Compliance:

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

getItemBatchAdminSessionForBank

ItemBatchAdminSession getItemBatchAdminSessionForBank(Id bankId)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

bankId - the Id of the Bank

Returns:

an ItemBatchAdminSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentBatchAdminSession

AssessmentBatchAdminSession getAssessmentBatchAdminSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk assessment administration service.

Returns:

an AssessmentBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentBatchAdmin() is false

Compliance:

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

getAssessmentBatchAdminSessionForBank

AssessmentBatchAdminSession getAssessmentBatchAdminSessionForBank(Id bankId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

bankId - the Id of the Bank

Returns:

an AssessmentBatchAdminSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentOfferedBatchAdminSession

AssessmentOfferedBatchAdminSession getAssessmentOfferedBatchAdminSession()
                                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk assessment offered administration service.

Returns:

an AssessmentOfferedBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedBatchAdmin() is false

Compliance:

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

getAssessmentOfferedBatchAdminSessionForBank

AssessmentOfferedBatchAdminSession getAssessmentOfferedBatchAdminSessionForBank(Id bankId)
                                                                                throws NotFoundException,
                                                                                       OperationFailedException

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

Parameters:

bankId - the Id of the Bank

Returns:

an AssessmentOfferedBatchAdminSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentTakenBatchAdminSession

AssessmentTakenBatchAdminSession getAssessmentTakenBatchAdminSession()
                                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk assessment taken administration service.

Returns:

an AssessmentTakenBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenBatchAdmin() is false

Compliance:

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

getAssessmentTakenBatchAdminSessionForBank

AssessmentTakenBatchAdminSession getAssessmentTakenBatchAdminSessionForBank(Id bankId)
                                                                            throws NotFoundException,
                                                                                   OperationFailedException

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

Parameters:

bankId - the Id of the Bank

Returns:

an AssessmentTakenBatchAdminSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getBankBatchAdminSession

BankBatchAdminSession getBankBatchAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk bank administration service.

Returns:

a BankBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBankBatchAdmin() is false

Compliance:

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