org.osid.dictionary.batch

Interface DictionaryBatchProxyManager

All Superinterfaces:

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

public interface DictionaryBatchProxyManager
extends OsidProxyManager, DictionaryBatchProfile

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

• 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(Proxy proxy) Gets the OsidSession associated with the bulk dictionary administration service.
EntryBatchAdminSession	getEntryBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk entry administration service.
EntryBatchAdminSession	getEntryBatchAdminSessionForDictionary(Id dictionaryId, Proxy proxy) Gets the OsidSession associated with the bulk entry administration service for the given dictionary.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk entry administration service.

Parameters:

proxy - a proxy

Returns:

an EntryBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

dictionaryId - the Id of the Dictionary

proxy - a proxy

Returns:

an EntryBatchAdminSession

Throws:

NotFoundException - no Dictionary found by the given Id

NullArgumentException - dictionaryId or proxy 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(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk dictionary administration service.

Parameters:

proxy - a proxy

Returns:

a DictionaryBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDictionaryBatchAdmin() is false

Compliance:

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