org.osid.dictionary.batch

Interface DictionaryBatchManager

All Superinterfaces:

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

public interface DictionaryBatchManager
extends OsidManager, DictionaryBatchProfile

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

• EntryBatchAdminSession: a session to create, modify and delete entries in bulk
• DictionaryBatchAdminSession: a session to create, modify and delete dictionaries in bulk

Method Summary

Methods

Modifier and Type	Method and Description
DictionaryBatchAdminSession	getDictionaryBatchAdminSession() Gets the OsidSession associated with the bulk dictionary administration service.
EntryBatchAdminSession	getEntryBatchAdminSession() Gets the OsidSession associated with the bulk entry administration service.
EntryBatchAdminSession	getEntryBatchAdminSessionForDictionary(Id dictionaryId) Gets the OsidSession associated with the bulk entry administration service for the given dictionary.

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.dictionary.batch.DictionaryBatchProfile

supportsDictionaryBatchAdmin, supportsEntryBatchAdmin, 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

getEntryBatchAdminSession

EntryBatchAdminSession getEntryBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk entry administration service.

Returns:

an EntryBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryBatchAdmin() is false

Compliance:

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

getEntryBatchAdminSessionForDictionary

EntryBatchAdminSession getEntryBatchAdminSessionForDictionary(Id dictionaryId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the bulk entry administration service for the given dictionary.

Parameters:

dictionaryId - the Id of the Dictionary

Returns:

an EntryBatchAdminSession

Throws:

NotFoundException - no Dictionary found by the given Id

NullArgumentException - dictionaryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getDictionaryBatchAdminSession

DictionaryBatchAdminSession getDictionaryBatchAdminSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk dictionary administration service.

Returns:

a DictionaryBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDictionaryBatchAdmin() is false

Compliance:

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