OSID Logo
OSID Specifications
dictionary batch package
Version 3.1.0
Interfaceosid.dictionary.batch.DictionaryBatchProxyManager
Implementsosid.OsidProxyManager
osid.dictionary.batch.DictionaryBatchProfile
Used Byosid.dictionary.DictionaryProxyManager
Description

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
MethodgetEntryBatchAdminSession
Description

Gets the OsidSession associated with the bulk entry administration service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.dictionary.batch.EntryBatchAdminSession an EntryBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryBatchAdmin() is false
Complianceoptional This method must be implemented if supportsEntryBatchAdmin() is true.
MethodgetEntryBatchAdminSessionForDictionary
Description

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

Parametersosid.id.IddictionaryId the Id of the Dictionary
osid.proxy.Proxyproxy a proxy
Returnosid.dictionary.batch.EntryBatchAdminSession an EntryBatchAdminSession
ErrorsNOT_FOUND no Dictionary found by the given Id
NULL_ARGUMENT dictionaryId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsEntryBatchAdmin() and supportsVisibleFederation() are true
MethodgetDictionaryBatchAdminSession
Description

Gets the OsidSession associated with the bulk dictionary administration service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.dictionary.batch.DictionaryBatchAdminSession a DictionaryBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsDictionaryBatchAdmin() is false
Complianceoptional This method must be implemented if supportsDictionaryBatchAdmin() is true.