OSID Logo
OSID Specifications
dictionary batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.batch.DictionaryBatchManager
Implementsosid.OsidManager
osid.dictionary.batch.DictionaryBatchProfile
Description

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

Gets the OsidSession associated with the bulk entry administration service.

Returnosid.dictionary.batch.EntryBatchAdminSessionan EntryBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryBatchAdmin() is false
ComplianceoptionalThis 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.IddictionaryIdthe Id of the Dictionary
Returnosid.dictionary.batch.EntryBatchAdminSessionan EntryBatchAdminSession
ErrorsNOT_FOUNDno Dictionary found by the given Id
NULL_ARGUMENT dictionaryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEntryBatchAdmin() and supportsVisibleFederation() are true
MethodgetDictionaryBatchAdminSession
Description

Gets the OsidSession associated with the bulk dictionary administration service.

Returnosid.dictionary.batch.DictionaryBatchAdminSessiona DictionaryBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDictionaryBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsDictionaryBatchAdmin() is true.