public interface DictionaryProxyManager extends OsidProxyManager, DictionaryProfile
The dictionary manager provides access to dictionary sessions and
provides interoperability tests for various aspects of this service.
Methods in this manager support a Proxy
to pass information
from server environments. 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(Proxy proxy)
Gets the
OsidSession used to administer dictionaries. |
DictionaryBatchProxyManager |
getDictionaryBatchProxyManager()
Gets a
DictionaryBatchProxyManager. |
DictionaryHierarchyDesignSession |
getDictionaryHierarchyDesignSession(Proxy proxy)
Gets the hierarchy managing the
Dictionary hierarchy. |
DictionaryHierarchySession |
getDictionaryHierarchySession(Proxy proxy)
Gets the hierarchy traversing the
Dictionary hierarchy. |
DictionaryLookupSession |
getDictionaryLookupSession(Proxy proxy)
Gets the
OsidSession used to lookup dictionaries. |
DictionaryNotificationSession |
getDictionaryNotificationSession(DictionaryReceiver dictionaryReceiver,
Proxy proxy)
Gets the
OsidSession used to subscribe to notifications
of new, updated or deleted dictionaries dictionaries. |
DictionaryQuerySession |
getDictionaryQuerySession(Proxy proxy)
Gets the
OsidSession used to query dictionaries. |
DictionarySearchSession |
getDictionarySearchSession(Proxy proxy)
Gets the
OsidSession used to search for dictionaries. |
EntryAdminSession |
getEntryAdminSession(Proxy proxy)
Gets the
OsidSession used to administer dictionary
entries. |
EntryAdminSession |
getEntryAdminSessionForDictionary(Id dictionaryId,
Proxy proxy)
Gets the
OsidSession used to administer dictionary
entries for the specified Dictionary . |
EntryDictionaryAssignmentSession |
getEntryDictionaryAssignmentSession(Proxy proxy)
Gets the session for assigning entry to dictionary mappings.
|
EntryDictionarySession |
getEntryDictionarySession(Proxy proxy)
Gets the session for retrieving entry to dictionary mappings.
|
EntryLookupSession |
getEntryLookupSession(Proxy proxy)
Gets the
OsidSession used to lookup dictionary entries. |
EntryLookupSession |
getEntryLookupSessionForDictionary(Id dictionaryId,
Proxy proxy)
Gets the
OsidSession used to lookup dictionary entries
for the specified Dictionary . |
EntryNotificationSession |
getEntryNotificationSession(EntryReceiver entryReceiver,
Proxy proxy)
Gets an
EntryNotificationSession which is responsible
for subscribing to entry changes within a default Dictionary. |
EntryNotificationSession |
getEntryNotificationSessionForDictionary(EntryReceiver entryReceiver,
Id dictionaryId,
Proxy proxy)
Gets an
EntryNotificationSession which is responsible
for subscribing to entry changes for a specified Dictionary. |
EntryQuerySession |
getEntryQuerySession(Proxy proxy)
Gets the
OsidSession used to query dictionary entries. |
EntryQuerySession |
getEntryQuerySessionForDictionary(Id dictionaryId,
Proxy proxy)
Gets the
OsidSession used to query dictionary entries
for the specified Dictionary . |
EntryRetrievalSession |
getEntryRetrievalSession(Proxy proxy)
Gets the
OsidSession used to retrieve dictionary
entries. |
EntryRetrievalSession |
getEntryRetrievalSessionForDictionary(Id dictionaryId,
Proxy proxy)
Gets the
OsidSession used to retrieve dictionary
entries for the specified Dictionary . |
EntrySearchSession |
getEntrySearchSession(Proxy proxy)
Gets the
OsidSession used to search among dictionary
entries. |
EntrySearchSession |
getEntrySearchSessionForDictionary(Id dictionaryId,
Proxy proxy)
Gets the
OsidSession used to search among dictionary
entries for the specified Dictionary . |
EntrySmartDictionarySession |
getEntrySmartDictionarySession(Id dictionaryId,
Proxy proxy)
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(Proxy proxy) throws OperationFailedException
OsidSession
used to retrieve dictionary
entries.proxy
- a proxy EntryRetrievalSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryRetrieval()
is false
optional
- This method must be implemented if
supportsEntryRetrieval()
is true.
EntryRetrievalSession getEntryRetrievalSessionForDictionary(Id dictionaryId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
used to retrieve dictionary
entries for the specified Dictionary
.dictionaryId
- the Id
of the Dictionary
to useproxy
- a proxy EntryRetrievalSession
NotFoundException
- no Dictionary
found
by the given Id
NullArgumentException
- dictionaryId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryRetrieval()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEntryRetrieval(),
supportsVisibleFederation()
are true. EntryLookupSession getEntryLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
used to lookup dictionary entries.proxy
- a proxy EntryLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryLookup()
is false
optional
- This method must be implemented if
supportsEntryLookup()
is true.
EntryLookupSession getEntryLookupSessionForDictionary(Id dictionaryId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
used to lookup dictionary entries
for the specified Dictionary
.dictionaryId
- the Id
of the Dictionary
to useproxy
- a proxy EntryLookupSession
NotFoundException
- no Dictionary
found
by the given Id
NullArgumentException
- dictionaryId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsEntryLookup(),
supportsVisibleFederation()
are true. EntryQuerySession getEntryQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
used to query dictionary entries.proxy
- a proxy EntryQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryQuery()
is false
optional
- This method must be implemented if
supportsEntryQuery()
is true.
EntryQuerySession getEntryQuerySessionForDictionary(Id dictionaryId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
used to query dictionary entries
for the specified Dictionary
.dictionaryId
- the Id
of the Dictionary
to useproxy
- a proxy EntryQuerySession
NotFoundException
- no Dictionary
found
by the given Id
NullArgumentException
- dictionaryId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsEntryQuery(),
supportsVisibleFederation()
are true. EntrySearchSession getEntrySearchSession(Proxy proxy) throws OperationFailedException
OsidSession
used to search among dictionary
entries.proxy
- a proxy EntrySearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntrySearch()
is false
optional
- This method must be implemented if
supportsEntrySearch()
is true.
EntrySearchSession getEntrySearchSessionForDictionary(Id dictionaryId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
used to search among dictionary
entries for the specified Dictionary
.dictionaryId
- the Id
of the Dictionary
to useproxy
- a proxy EntrySearchSession
NotFoundException
- no Dictionary
found
by the given Id
NullArgumentException
- dictionaryId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntrySearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsEntrySearch(),
supportsVisibleFederation()
are true. EntryAdminSession getEntryAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
used to administer dictionary
entries.proxy
- a proxy EntryAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryAdmin()
is false
optional
- This method must be implemented if
supportsEntryAdmin()
is true.
EntryAdminSession getEntryAdminSessionForDictionary(Id dictionaryId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
used to administer dictionary
entries for the specified Dictionary
.dictionaryId
- the Id
of the Dictionary
to useproxy
- a proxy EntryAdminSession
NotFoundException
- no Dictionary
found
by the given Id
NullArgumentException
- dictionaryId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryAdmin()
os supportsVisibleFederration()
is
false
optional
- This method must be implemented if
supportsEntryAdmin(),
supportsVisibleFederation()
are true. EntryNotificationSession getEntryNotificationSession(EntryReceiver entryReceiver, Proxy proxy) throws OperationFailedException
EntryNotificationSession
which is responsible
for subscribing to entry changes within a default Dictionary.
entryReceiver
- the notification callbackproxy
- a proxy EntryNotificationSession
NullArgumentException
- entryReceiver
or
proxy
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, Proxy proxy) 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 useproxy
- a proxy EntryNotificationSession
NotFoundException
- no Dictionary
found
by the given Id
NullArgumentException
- entryReceiver,
dictionaryId
or proxy
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(Proxy proxy) throws OperationFailedException
proxy
- a proxy EntryDictionarySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryDictionary()
is false
optional
- This method must be implemented if
supportsEntryDictionary()
is true.
EntryDictionaryAssignmentSession getEntryDictionaryAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy EntryDictionaryAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryDictionaryAssignment()
is false
optional
- This method must be implemented if
supportsEntryDictionaryAssignment()
is
true.
EntrySmartDictionarySession getEntrySmartDictionarySession(Id dictionaryId, Proxy proxy) throws NotFoundException, OperationFailedException
dictionaryId
- the Id
of the dictionaryproxy
- a proxy EntrySmartDictionarySession
NotFoundException
- dictionaryId
not
foundNullArgumentException
- dictionaryId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntrySmartDictionary()
is false
optional
- This method must be implemented if
supportsEntrySmartDictionary()
is true.
DictionaryLookupSession getDictionaryLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
used to lookup dictionaries.proxy
- a proxy DictionaryLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDictionaryLookup()
is false
optional
- This method must be implemented if
supportsDictionaryLookup()
and
supportsVisibleFederation()
are true.
DictionaryQuerySession getDictionaryQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
used to query dictionaries.proxy
- a proxy DictionaryQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDictionaryQuery()
is false
optional
- This method must be implemented if
supportsDictionaryQuery()
and
supportsVisibleFederation()
are true.
DictionarySearchSession getDictionarySearchSession(Proxy proxy) throws OperationFailedException
OsidSession
used to search for dictionaries.proxy
- a proxy DictionarySearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDictionarySearch()
is false
optional
- This method must be implemented if
supportsDictionarySearch()
and
supportsVisibleFederation()
are true.
DictionaryAdminSession getDictionaryAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
used to administer dictionaries.proxy
- a proxy DictionaryAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDictionaryAdmin()
is false
optional
- This method must be implemented if
supportsDictionaryAdmin()
is true.
DictionaryNotificationSession getDictionaryNotificationSession(DictionaryReceiver dictionaryReceiver, Proxy proxy) throws OperationFailedException
OsidSession
used to subscribe to notifications
of new, updated or deleted dictionaries dictionaries.dictionaryReceiver
- the notification callbackproxy
- a proxy DictionaryNotificationSession
NullArgumentException
- dictionaryReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDictionaryNotification()
is false
optional
- This method must be implemented if
supportsDictionaryNotification()
is true.
DictionaryHierarchySession getDictionaryHierarchySession(Proxy proxy) throws OperationFailedException
Dictionary
hierarchy.
The parent includes all dictionary elements of its children.proxy
- a proxy DictionaryHierarchySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsDictionaryHierarchy()
is false
optional
- This method must be implemented if
supportsDictionaryHierarchyTraversal()
is
true.
DictionaryHierarchyDesignSession getDictionaryHierarchyDesignSession(Proxy proxy) throws OperationFailedException
Dictionary
hierarchy.
The parent includes all dictionary elements of its children.proxy
- a proxy DictionaryHierarchyDesignSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsDictionaryHierarchyDesign()
is false
optional
- This method must be implemented if
supportsDictionaryHierarchyDesign()
is
true.
DictionaryBatchProxyManager getDictionaryBatchProxyManager() throws OperationFailedException
DictionaryBatchProxyManager.
DictionaryBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDictionaryBatch()
is false
optional
- This method must be implemented.