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 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. |
changeBranch, initialize, rollbackService
close
supportsDictionaryBatchAdmin, supportsEntryBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
EntryBatchAdminSession getEntryBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk entry
administration service. EntryBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryBatchAdmin()
is false
optional
- This method must be implemented if
supportsEntryBatchAdmin()
is true.
EntryBatchAdminSession getEntryBatchAdminSessionForDictionary(Id dictionaryId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk entry
administration service for the given dictionary.dictionaryId
- the Id
of the Dictionary
EntryBatchAdminSession
NotFoundException
- no Dictionary
found
by the given Id
NullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEntryBatchAdmin()
and
supportsVisibleFederation()
are true
DictionaryBatchAdminSession getDictionaryBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk
dictionary administration service. DictionaryBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDictionaryBatchAdmin()
is false
optional
- This method must be implemented if
supportsDictionaryBatchAdmin()
is true.