public interface DictionaryManager extends OsidManager, DictionaryProfile
The dictionary manager provides access to dictionary sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
EntryRetrievalSession:
a basic session for
retrieving dictoonary entries EntryLookupSession:
a session for looking up
dictionary entries EntryQuerySession:
a session for querying
dictionary entries EntrySearchSession:
a session for searching for
dictionary entries EntryAdminSession:
a session for creating,
updating, and delting dictionary entries EntryNotificationSession:
a session for
subscribing to notifications about dictionary entries EntryDictionarySession:
a session to look up entry
to dictionary mappings EntryDictionaryAssignmentSession:
a session to
manage entry to dictionary mappings EntrySmartDictionarySession:
a session to manage
smart entry dictionaries DictionaryLookupSession
a session for looking up
dictionaries DictionaryQuerySession
a session for querying
dictionaries DictionarySearchSession
a session for searchin
gamong dictionaries DictionaryAdminSession
a session creating,
updating or deleting dictionaries DictionaryNotificationSession:
a session for
subscribing to adds and changes of dictionaries DictionaryHierarchySession:
a session for
traversing the hierarchy of dictionaries DictionaryHierarchyDesignSession:
a session for
managing the dictionary hierarchy Modifier and Type | Method and Description |
---|---|
DictionaryAdminSession |
getDictionaryAdminSession()
Gets the
OsidSession used to administer dictionaries |
DictionaryBatchManager |
getDictionaryBatchManager()
Gets a
DictionaryBatchManager. |
DictionaryHierarchyDesignSession |
getDictionaryHierarchyDesignSession()
Gets hierarchy service for structuring
Dictionary
objects. |
DictionaryHierarchySession |
getDictionaryHierarchySession()
Gets hierarchy service for traversing the
Dictionary
hierarchy. |
DictionaryLookupSession |
getDictionaryLookupSession()
Gets the
OsidSession used to lookup dictionaries. |
DictionaryNotificationSession |
getDictionaryNotificationSession(DictionaryReceiver dictionaryReceiver)
Gets the
OsidSession used to receive notifications of
dictionary changes. |
DictionaryQuerySession |
getDictionaryQuerySession()
Gets the
OsidSession used to query dictionaries. |
DictionarySearchSession |
getDictionarySearchSession()
Gets the
OsidSession used to search dictionaries. |
EntryAdminSession |
getEntryAdminSession()
Gets the
OsidSession used to administer dictionary
entries. |
EntryAdminSession |
getEntryAdminSessionForDictionary(Id dictionaryId)
Gets the
OsidSession used to administer dictionary
entries for the specified Dictionary. |
EntryDictionaryAssignmentSession |
getEntryDictionaryAssignmentSession()
Gets the session for assigning entry to dictionary mappings.
|
EntryDictionarySession |
getEntryDictionarySession()
Gets the session for retrieving entry to dictionary mappings.
|
EntryLookupSession |
getEntryLookupSession()
Gets the
OsidSession used to retrieve dictionary
entries. |
EntryLookupSession |
getEntryLookupSessionForDictionary(Id dictionaryId)
Gets the
OsidSession used to lookup dictionary entries
for the specified Dictionary. |
EntryNotificationSession |
getEntryNotificationSession(EntryReceiver entryReceiver)
Gets an
EntryNotificationSession which is responsible
for subscribing to entry changes within a default Dictionary. |
EntryNotificationSession |
getEntryNotificationSessionForDictionary(EntryReceiver entryReceiver,
Id dictionaryId)
Gets an
EntryNotificationSession which is responsible
for subscribing to entry changes for a specified Dictionary. |
EntryQuerySession |
getEntryQuerySession()
Gets the
OsidSession used to query dictionary entries. |
EntryQuerySession |
getEntryQuerySessionForDictionary(Id dictionaryId)
Gets the
OsidSession used to query dictionary entries
for the specified Dictionary. |
EntryRetrievalSession |
getEntryRetrievalSession()
Gets the
OsidSession used to retrieve dictionary
entries. |
EntryRetrievalSession |
getEntryRetrievalSessionForDictionary(Id dictionaryId)
Gets the
OsidSession used to retrieve dictionary
entries for the specified Dictionary. |
EntrySearchSession |
getEntrySearchSession()
Gets the
OsidSession used to search dictionary entries. |
EntrySearchSession |
getEntrySearchSessionForDictionary(Id dictionaryId)
Gets the
OsidSession used to search dictionary entries
for the specified Dictionary. |
EntrySmartDictionarySession |
getEntrySmartDictionarySession(Id dictionaryId)
Gets the session for managing dynamic entry dictionarys.
|
changeBranch, initialize, rollbackService
close
getDictionaryRecordTypes, getDictionarySearchRecordTypes, getEntryKeyTypes, getEntryRecordTypes, getEntrySearchRecordTypes, getEntryValueTypes, getEntryValueTypesForKeyType, supportsDictionaryAdmin, supportsDictionaryBatch, supportsDictionaryHierachyDesign, supportsDictionaryHierachyTraversal, supportsDictionaryLookup, supportsDictionaryNotification, supportsDictionaryQuery, supportsDictionaryRecordType, supportsDictionarySearch, supportsDictionarySearchRecordType, supportsEntryAdmin, supportsEntryDictionary, supportsEntryDictionaryAssignment, supportsEntryKeyType, supportsEntryLookup, supportsEntryNotification, supportsEntryQuery, supportsEntryRecordType, supportsEntryRetrieval, supportsEntrySearch, supportsEntrySearchRecordType, supportsEntrySmartDictionary, supportsEntryTypes, supportsEntryValueType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
EntryRetrievalSession getEntryRetrievalSession() throws OperationFailedException
OsidSession
used to retrieve dictionary
entries. EntryRetrievalSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryRetrieval()
is false
optional
- This method must be implemented if
supportsEntryRetrieval()
is true.
EntryRetrievalSession getEntryRetrievalSessionForDictionary(Id dictionaryId) throws NotFoundException, OperationFailedException
OsidSession
used to retrieve dictionary
entries for the specified Dictionary.
dictionaryId
- the Id
of the Dictionary
to use EntryRetrievalSession
NotFoundException
- no Dictionary
found
by the given Id
NullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryRetrieval()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEntryRetrieval()
and
supportsVisibleFederation()
are true.
EntryLookupSession getEntryLookupSession() throws OperationFailedException
OsidSession
used to retrieve dictionary
entries. EntryLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryLookup()
is false
optional
- This method must be implemented if
supportsEntryLookup()
is true.
EntryLookupSession getEntryLookupSessionForDictionary(Id dictionaryId) throws NotFoundException, OperationFailedException
OsidSession
used to lookup dictionary entries
for the specified Dictionary.
dictionaryId
- the Id
of the Dictionary
to use EntryLookupSession
NotFoundException
- no Dictionary
found
by the given Id
NullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsEntryLookup()
and
supportsVisibleFederation()
are true.
EntryQuerySession getEntryQuerySession() throws OperationFailedException
OsidSession
used to query dictionary entries. EntryQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryQuery()
is false
optional
- This method must be implemented if
supportsEntryQuery()
is true.
EntryQuerySession getEntryQuerySessionForDictionary(Id dictionaryId) throws NotFoundException, OperationFailedException
OsidSession
used to query dictionary entries
for the specified Dictionary.
dictionaryId
- the Id
of the Dictionary
to use EntryQuerySession
NotFoundException
- no Dictionary
found
by the given Id
NullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsEntryQuery()
and
supportsVisibleFederation()
are true.
EntrySearchSession getEntrySearchSession() throws OperationFailedException
OsidSession
used to search dictionary entries. EntrySearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntrySearch()
is false
optional
- This method must be implemented if
supportsEntrySearch()
is true.
EntrySearchSession getEntrySearchSessionForDictionary(Id dictionaryId) throws NotFoundException, OperationFailedException
OsidSession
used to search dictionary entries
for the specified Dictionary.
dictionaryId
- the Id
of the Dictionary
to use EntrySearchSession
NotFoundException
- no Dictionary
found
by the given Id
NullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntrySearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsEntrySearch()
and
supportsVisibleFederation()
are true.
EntryAdminSession getEntryAdminSession() throws OperationFailedException
OsidSession
used to administer dictionary
entries. EntryAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryAdmin()
is false
optional
- This method must be implemented if
supportsEntryAdmin()
is true.
EntryAdminSession getEntryAdminSessionForDictionary(Id dictionaryId) throws NotFoundException, OperationFailedException
OsidSession
used to administer dictionary
entries for the specified Dictionary.
dictionaryId
- the Id
of the Dictionary
to use EntryAdminSession
NotFoundException
- no Dictionary
found
by the given Id
NullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryAdmin()
os supportsVisibleFederration()
is
false
optional
- This method must be implemented if
supportsEntryAdmin()
and
supportsVisibleFederation()
are true.
EntryNotificationSession getEntryNotificationSession(EntryReceiver entryReceiver) throws OperationFailedException
EntryNotificationSession
which is responsible
for subscribing to entry changes within a default Dictionary.
entryReceiver
- the notification callback EntryNotificationSession
NullArgumentException
- entryReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryNotification()
is false
optional
- This method must be implemented if
supportsEntryNotification()
is true.
EntryNotificationSession getEntryNotificationSessionForDictionary(EntryReceiver entryReceiver, Id dictionaryId) throws NotFoundException, OperationFailedException
EntryNotificationSession
which is responsible
for subscribing to entry changes for a specified Dictionary.
entryReceiver
- the notification callbackdictionaryId
- the Id
of the Dictionary
to use EntryNotificationSession
NotFoundException
- no Dictionary
found
by the given Id
NullArgumentException
- entryReceiver
or
dictionaryId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEntryNotification ()
and
supportsVisibleFederation()
are true.
EntryDictionarySession getEntryDictionarySession() throws OperationFailedException
EntryDictionarySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryDictionary()
is false
optional
- This method must be implemented if
supportsEntryDictionary()
is true.
EntryDictionaryAssignmentSession getEntryDictionaryAssignmentSession() throws OperationFailedException
EntryDictionaryAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryDictionaryAssignment()
is false
optional
- This method must be implemented if
supportsEntryDictionaryAssignment()
is
true.
EntrySmartDictionarySession getEntrySmartDictionarySession(Id dictionaryId) throws NotFoundException, OperationFailedException
dictionaryId
- the Id
of the dictionary EntrySmartDictionarySession
NotFoundException
- dictionaryId
not
foundNullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntrySmartDictionary()
is false
optional
- This method must be implemented if
supportsEntrySmartDictionary()
is true.
DictionaryLookupSession getDictionaryLookupSession() throws OperationFailedException
OsidSession
used to lookup dictionaries. DictionaryLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDictionaryLookup()
is false
optional
- This method must be implemented if
supportsDictionaryLookup()
and
supportsVisibleFederation()
are true.
DictionaryQuerySession getDictionaryQuerySession() throws OperationFailedException
OsidSession
used to query dictionaries. DictionaryQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDictionaryQuery()
is false
optional
- This method must be implemented if
supportsDictionaryQuery()
and
supportsVisibleFederation()
are true.
DictionarySearchSession getDictionarySearchSession() throws OperationFailedException
OsidSession
used to search dictionaries. DictionarySearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDictionarySearch()
is false
optional
- This method must be implemented if
supportsDictionarySearch()
and
supportsVisibleFederation()
are true.
DictionaryAdminSession getDictionaryAdminSession() throws OperationFailedException
OsidSession
used to administer dictionaries DictionaryAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDictionaryAdmin()
is false
optional
- This method must be implemented if
supportsDictionaryAdmin()
is true.
DictionaryNotificationSession getDictionaryNotificationSession(DictionaryReceiver dictionaryReceiver) throws OperationFailedException
OsidSession
used to receive notifications of
dictionary changes.dictionaryReceiver
- the notification callback DictionaryNotificationSession
NullArgumentException
- dictionaryReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDictionaryNotification()
is false
optional
- This method must be implemented if
supportsDictionaryNotification()
is true.
DictionaryHierarchySession getDictionaryHierarchySession() throws OperationFailedException
Dictionary
hierarchy. A parent includes all the dictionary entries of its
children. HierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDictionaryHierarchyTraversal()
is false
optional
- This method must be implemented. DictionaryHierarchyDesignSession getDictionaryHierarchyDesignSession() throws OperationFailedException
Dictionary
objects. DictionaryHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDictionaryHierarchyDesign()
is false
optional
- This method must be implemented. DictionaryBatchManager getDictionaryBatchManager() throws OperationFailedException
DictionaryBatchManager.
DictionaryBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDictionaryBatch()
is false
optional
- This method must be implemented.