Interface DictionaryProxyManager
- All Superinterfaces:
AutoCloseable, Closeable, DictionaryProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable
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 -
DictionaryLookupSessiona session for looking up dictionaries -
DictionaryQuerySessiona session for querying dictionaries -
DictionarySearchSessiona session for searchin gamong dictionaries -
DictionaryAdminSessiona 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
-
Method Summary
Modifier and TypeMethodDescriptiongetDictionaryAdminSession(Proxy proxy) Gets theOsidSessionused to administer dictionaries.Gets aDictionaryBatchProxyManager.Gets the hierarchy managing theDictionaryhierarchy.Gets the hierarchy traversing theDictionaryhierarchy.getDictionaryLookupSession(Proxy proxy) Gets theOsidSessionused to lookup dictionaries.getDictionaryNotificationSession(DictionaryReceiver dictionaryReceiver, Proxy proxy) Gets theOsidSessionused to subscribe to notifications of new, updated or deleted dictionaries dictionaries.getDictionaryQuerySession(Proxy proxy) Gets theOsidSessionused to query dictionaries.getDictionarySearchSession(Proxy proxy) Gets theOsidSessionused to search for dictionaries.getEntryAdminSession(Proxy proxy) Gets theOsidSessionused to administer dictionary entries.getEntryAdminSessionForDictionary(Id dictionaryId, Proxy proxy) Gets theOsidSessionused to administer dictionary entries for the specifiedDictionary.Gets the session for assigning entry to dictionary mappings.getEntryDictionarySession(Proxy proxy) Gets the session for retrieving entry to dictionary mappings.getEntryLookupSession(Proxy proxy) Gets theOsidSessionused to lookup dictionary entries.getEntryLookupSessionForDictionary(Id dictionaryId, Proxy proxy) Gets theOsidSessionused to lookup dictionary entries for the specifiedDictionary.getEntryNotificationSession(EntryReceiver entryReceiver, Proxy proxy) Gets anEntryNotificationSessionwhich is responsible for subscribing to entry changes within a defaultDictionary.getEntryNotificationSessionForDictionary(EntryReceiver entryReceiver, Id dictionaryId, Proxy proxy) Gets anEntryNotificationSessionwhich is responsible for subscribing to entry changes for a specifiedDictionary.getEntryQuerySession(Proxy proxy) Gets theOsidSessionused to query dictionary entries.getEntryQuerySessionForDictionary(Id dictionaryId, Proxy proxy) Gets theOsidSessionused to query dictionary entries for the specifiedDictionary.getEntryRetrievalSession(Proxy proxy) Gets theOsidSessionused to retrieve dictionary entries.getEntryRetrievalSessionForDictionary(Id dictionaryId, Proxy proxy) Gets theOsidSessionused to retrieve dictionary entries for the specifiedDictionary.getEntrySearchSession(Proxy proxy) Gets theOsidSessionused to search among dictionary entries.getEntrySearchSessionForDictionary(Id dictionaryId, Proxy proxy) Gets theOsidSessionused to search among dictionary entries for the specifiedDictionary.getEntrySmartDictionarySession(Id dictionaryId, Proxy proxy) Gets the session for managing dynamic entry dictionarys.Methods inherited from interface DictionaryProfile
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, supportsVisibleFederationModifier and TypeMethodDescriptionGets the supportedDictionaryrecord types.Gets the supportedDictionarysearch record types.Gets the supportedEntrykey types.Gets the supportedEntryrecord types.Gets the supportedEntrysearch record types.Gets the supportedEntryvalue types.getEntryValueTypesForKeyType(Type entryKeyType) Gets the list of value types supported for the given key type.booleanTests if a dictionary administrative service is supported.booleanTests if a dictionary batch service is supported.booleanTests if a dictionary hierarchy design service is supported.booleanTests if a dictionary hierarchy traversal service is supported.booleanTests if a dictionary lookup service is supported.booleanTests if a dictionary notification service is supported.booleanTests if a dictionary query service is supported.booleansupportsDictionaryRecordType(Type dictionaryRecordType) Tests if the givenDictionaryrecord type is supported.booleanTests if a dictionary search service is supported.booleansupportsDictionarySearchRecordType(Type dictionarySearchRecordType) Tests if the givenDictionarysearch record type is supported.booleanTests if a dictionary entry administrative service is supported.booleanTests if retrieving mappings of entry and dictionarys is supported.booleanTests if managing mappings of entry and dictionarys is supported.booleansupportsEntryKeyType(Type entryKeyType) Tests if the givenEntrykey type is supported.booleanTests if looking up dictionary entries are supported.booleanTests if a dictionary entry notification service is supported.booleanTests if querying dictionary entries are supported.booleansupportsEntryRecordType(Type entryRecordType) Tests if the givenEntryrecord type is supported.booleanTests if retrieving dictionary entries are supported.booleanTests if searching dictionary entries are supported.booleansupportsEntrySearchRecordType(Type entrySearchRecordType) Tests if the givenEntrysearch record type is supported.booleanTests if entry smart dictionarys are available.booleansupportsEntryTypes(Type entryKeyType, Type entryValueType) Tests if the givenEntrykey and value types are supported.booleansupportsEntryValueType(Type entryValueType) Tests if the givenEntryvalue type is supported.booleanTests if any dictionary federation is exposed.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface OsidProxyManager
closeMethods inherited from interface OsidProxyManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId, Proxy proxy) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getEntryRetrievalSession
Gets theOsidSessionused to retrieve dictionary entries.- Parameters:
proxy- a proxy- Returns:
- an
EntryRetrievalSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEntryRetrieval()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEntryRetrieval()} is {@code true} .
-
getEntryRetrievalSessionForDictionary
EntryRetrievalSession getEntryRetrievalSessionForDictionary(Id dictionaryId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionused to retrieve dictionary entries for the specifiedDictionary.- Parameters:
dictionaryId- theIdof theDictionaryto useproxy- a proxy- Returns:
- an
EntryRetrievalSession - Throws:
NotFoundException- noDictionaryfound by the givenIdNullArgumentException-dictionaryIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEntryRetrieval()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEntryRetrieval()} , {@code supportsVisibleFederation()} are true.
-
getEntryLookupSession
Gets theOsidSessionused to lookup dictionary entries.- Parameters:
proxy- a proxy- Returns:
- an
EntryLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEntryLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEntryLookup()} is {@code true} .
-
getEntryLookupSessionForDictionary
EntryLookupSession getEntryLookupSessionForDictionary(Id dictionaryId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionused to lookup dictionary entries for the specifiedDictionary.- Parameters:
dictionaryId- theIdof theDictionaryto useproxy- a proxy- Returns:
- an
EntryLookupSession - Throws:
NotFoundException- noDictionaryfound by the givenIdNullArgumentException-dictionaryIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEntryLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEntryLookup()} , {@code supportsVisibleFederation()} are true.
-
getEntryQuerySession
Gets theOsidSessionused to query dictionary entries.- Parameters:
proxy- a proxy- Returns:
- an
EntryQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEntryQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEntryQuery()} is {@code true} .
-
getEntryQuerySessionForDictionary
EntryQuerySession getEntryQuerySessionForDictionary(Id dictionaryId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionused to query dictionary entries for the specifiedDictionary.- Parameters:
dictionaryId- theIdof theDictionaryto useproxy- a proxy- Returns:
- an
EntryQuerySession - Throws:
NotFoundException- noDictionaryfound by the givenIdNullArgumentException-dictionaryIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEntryQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEntryQuery()} , {@code supportsVisibleFederation()} are true.
-
getEntrySearchSession
Gets theOsidSessionused to search among dictionary entries.- Parameters:
proxy- a proxy- Returns:
- an
EntrySearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEntrySearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEntrySearch()} is {@code true} .
-
getEntrySearchSessionForDictionary
EntrySearchSession getEntrySearchSessionForDictionary(Id dictionaryId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionused to search among dictionary entries for the specifiedDictionary.- Parameters:
dictionaryId- theIdof theDictionaryto useproxy- a proxy- Returns:
- an
EntrySearchSession - Throws:
NotFoundException- noDictionaryfound by the givenIdNullArgumentException-dictionaryIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEntrySearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEntrySearch()} , {@code supportsVisibleFederation()} are true.
-
getEntryAdminSession
Gets theOsidSessionused to administer dictionary entries.- Parameters:
proxy- a proxy- Returns:
- an
EntryAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEntryAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEntryAdmin()} is {@code true} .
-
getEntryAdminSessionForDictionary
EntryAdminSession getEntryAdminSessionForDictionary(Id dictionaryId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionused to administer dictionary entries for the specifiedDictionary.- Parameters:
dictionaryId- theIdof theDictionaryto useproxy- a proxy- Returns:
- an
EntryAdminSession - Throws:
NotFoundException- noDictionaryfound by the givenIdNullArgumentException-dictionaryIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEntryAdmin()ossupportsVisibleFederration()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEntryAdmin()} , {@code supportsVisibleFederation()} are true.
-
getEntryNotificationSession
EntryNotificationSession getEntryNotificationSession(EntryReceiver entryReceiver, Proxy proxy) throws OperationFailedException Gets anEntryNotificationSessionwhich is responsible for subscribing to entry changes within a defaultDictionary.- Parameters:
entryReceiver- the notification callbackproxy- a proxy- Returns:
- an
EntryNotificationSession - Throws:
NullArgumentException-entryReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEntryNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEntryNotification()} is {@code true} .
-
getEntryNotificationSessionForDictionary
EntryNotificationSession getEntryNotificationSessionForDictionary(EntryReceiver entryReceiver, Id dictionaryId, Proxy proxy) throws NotFoundException, OperationFailedException Gets anEntryNotificationSessionwhich is responsible for subscribing to entry changes for a specifiedDictionary.- Parameters:
entryReceiver- the notification callbackdictionaryId- theIdof theDictionaryto useproxy- a proxy- Returns:
- an
EntryNotificationSession - Throws:
NotFoundException- noDictionaryfound by the givenIdNullArgumentException-entryReceiver, dictionaryIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEntryNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEntryNotification()} and {@code supportsVisibleFederation()} are true.
-
getEntryDictionarySession
Gets the session for retrieving entry to dictionary mappings.- Parameters:
proxy- a proxy- Returns:
- a
EntryDictionarySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEntryDictionary()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEntryDictionary()} is {@code true} .
-
getEntryDictionaryAssignmentSession
EntryDictionaryAssignmentSession getEntryDictionaryAssignmentSession(Proxy proxy) throws OperationFailedException Gets the session for assigning entry to dictionary mappings.- Parameters:
proxy- a proxy- Returns:
- a
EntryDictionaryAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEntryDictionaryAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEntryDictionaryAssignment()} is {@code true} .
-
getEntrySmartDictionarySession
EntrySmartDictionarySession getEntrySmartDictionarySession(Id dictionaryId, Proxy proxy) throws NotFoundException, OperationFailedException Gets the session for managing dynamic entry dictionarys.- Parameters:
dictionaryId- theIdof the dictionaryproxy- a proxy- Returns:
- a
EntrySmartDictionarySession - Throws:
NotFoundException-dictionaryIdnot foundNullArgumentException-dictionaryIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEntrySmartDictionary()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEntrySmartDictionary()} is {@code true} .
-
getDictionaryLookupSession
Gets theOsidSessionused to lookup dictionaries.- Parameters:
proxy- a proxy- Returns:
- a
DictionaryLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDictionaryLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDictionaryLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getDictionaryQuerySession
Gets theOsidSessionused to query dictionaries.- Parameters:
proxy- a proxy- Returns:
- a
DictionaryQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDictionaryQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDictionaryQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getDictionarySearchSession
Gets theOsidSessionused to search for dictionaries.- Parameters:
proxy- a proxy- Returns:
- a
DictionarySearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDictionarySearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDictionarySearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getDictionaryAdminSession
Gets theOsidSessionused to administer dictionaries.- Parameters:
proxy- a proxy- Returns:
- a
DictionaryAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDictionaryAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDictionaryAdmin()} is {@code true} .
-
getDictionaryNotificationSession
DictionaryNotificationSession getDictionaryNotificationSession(DictionaryReceiver dictionaryReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionused to subscribe to notifications of new, updated or deleted dictionaries dictionaries.- Parameters:
dictionaryReceiver- the notification callbackproxy- a proxy- Returns:
- a
DictionaryNotificationSession - Throws:
NullArgumentException-dictionaryReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDictionaryNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDictionaryNotification()} is {@code true} .
-
getDictionaryHierarchySession
DictionaryHierarchySession getDictionaryHierarchySession(Proxy proxy) throws OperationFailedException Gets the hierarchy traversing theDictionaryhierarchy. The parent includes all dictionary elements of its children.- Parameters:
proxy- a proxy- Returns:
- a
DictionaryHierarchySession - Throws:
NullArgumentException-proxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsDictionaryHierarchy()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDictionaryHierarchyTraversal()} is {@code true} .
-
getDictionaryHierarchyDesignSession
DictionaryHierarchyDesignSession getDictionaryHierarchyDesignSession(Proxy proxy) throws OperationFailedException Gets the hierarchy managing theDictionaryhierarchy. The parent includes all dictionary elements of its children.- Parameters:
proxy- a proxy- Returns:
- a
DictionaryHierarchyDesignSession - Throws:
NullArgumentException-proxyisnullOperationFailedException-unable to complete requestUnimplementedException-supportsDictionaryHierarchyDesign()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDictionaryHierarchyDesign()} is {@code true} .
-
getDictionaryBatchProxyManager
Gets aDictionaryBatchProxyManager.- Returns:
- a
DictionaryBatchProxyManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsDictionaryBatch()isfalse- Compliance:
optional- This method must be implemented.
-