Interface AssessmentBatchProxyManager

All Superinterfaces:

AssessmentBatchProfile, AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface AssessmentBatchProxyManager
extends OsidProxyManager, AssessmentBatchProfile

The assessment batch proxy manager provides access to assessment 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:

• 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

Modifier and Type	Method	Description
AssessmentBatchAdminSession	getAssessmentBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk assessment administration service.
AssessmentBatchAdminSession	getAssessmentBatchAdminSessionForBank(Id bankId, Proxy proxy)	Gets the OsidSession associated with the bulk assessment administration service for the given bank.
AssessmentOfferedBatchAdminSession	getAssessmentOfferedBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk assessment offered administration service.
AssessmentOfferedBatchAdminSession	getAssessmentOfferedBatchAdminSessionForBank(Id bankId, Proxy proxy)	Gets the OsidSession associated with the bulk assessment offered administration service for the given bank.
AssessmentTakenBatchAdminSession	getAssessmentTakenBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk assessment taken administration service.
AssessmentTakenBatchAdminSession	getAssessmentTakenBatchAdminSessionForBank(Id bankId, Proxy proxy)	Gets the OsidSession associated with the bulk assessment taken administration service for the given bank.
BankBatchAdminSession	getBankBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk bank administration service.
ItemBatchAdminSession	getItemBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk item administration service.
ItemBatchAdminSession	getItemBatchAdminSessionForBank(Id bankId, Proxy proxy)	Gets the OsidSession associated with the bulk item administration service for the given bank.

Methods inherited from interface AssessmentBatchProfile

supportsAssessmentBatchAdmin, supportsAssessmentOfferedBatchAdmin, supportsAssessmentTakenBatchAdmin, supportsBankBatchAdmin, supportsItemBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsAssessmentBatchAdmin()	Tests if bulk administration of assessments is available.
boolean	supportsAssessmentOfferedBatchAdmin()	Tests if bulk administration of assessments offered is available.
boolean	supportsAssessmentTakenBatchAdmin()	Tests if bulk administration of assessments taken is available.
boolean	supportsBankBatchAdmin()	Tests if bulk administration of banks is available.
boolean	supportsItemBatchAdmin()	Tests if bulk administration of items is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Closeable

close

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

getItemBatchAdminSession

ItemBatchAdminSession getItemBatchAdminSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the bulk item administration service.

Parameters:

proxy - a proxy

Returns:

an ItemBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBatchAdmin() is false

Compliance:

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

getItemBatchAdminSessionForBank

ItemBatchAdminSession getItemBatchAdminSessionForBank(Id bankId,
 Proxy proxy)
                                               throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

an ItemBatchAdminSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentBatchAdminSession

AssessmentBatchAdminSession getAssessmentBatchAdminSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the bulk assessment administration service.

Parameters:

proxy - a proxy

Returns:

an AssessmentBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentBatchAdmin() is false

Compliance:

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

getAssessmentBatchAdminSessionForBank

AssessmentBatchAdminSession getAssessmentBatchAdminSessionForBank(Id bankId,
 Proxy proxy)
                                                           throws NotFoundException,
OperationFailedException

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

Parameters:

bankId - the Id of the Bank

proxy - a proxy

Returns:

an AssessmentBatchAdminSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentOfferedBatchAdminSession

AssessmentOfferedBatchAdminSession getAssessmentOfferedBatchAdminSession(Proxy proxy)
                                                                  throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

an AssessmentOfferedBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedBatchAdmin() is false

Compliance:

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

getAssessmentOfferedBatchAdminSessionForBank

AssessmentOfferedBatchAdminSession getAssessmentOfferedBatchAdminSessionForBank(Id bankId,
 Proxy proxy)
                                                                         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

proxy - a proxy

Returns:

an AssessmentOfferedBatchAdminSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentOfferedBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAssessmentTakenBatchAdminSession

AssessmentTakenBatchAdminSession getAssessmentTakenBatchAdminSession(Proxy proxy)
                                                              throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

an AssessmentTakenBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenBatchAdmin() is false

Compliance:

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

getAssessmentTakenBatchAdminSessionForBank

AssessmentTakenBatchAdminSession getAssessmentTakenBatchAdminSessionForBank(Id bankId,
 Proxy proxy)
                                                                     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

proxy - a proxy

Returns:

an AssessmentTakenBatchAdminSession

Throws:

NotFoundException - no Bank found by the given Id

NullArgumentException - bankId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAssessmentTakenBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getBankBatchAdminSession

BankBatchAdminSession getBankBatchAdminSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the bulk bank administration service.

Parameters:

proxy - a proxy

Returns:

a BankBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBankBatchAdmin() is false

Compliance:

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