org.osid.dictionary

Interface DictionaryProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, DictionaryProfile, OsidProfile, OsidProxyManager, Sourceable

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

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.dictionary.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, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getEntryRetrievalSession

EntryRetrievalSession getEntryRetrievalSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession used to retrieve dictionary entries.

Parameters:

proxy - a proxy

Returns:

an EntryRetrievalSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryRetrieval() is false

Compliance:

optional - This method must be implemented if supportsEntryRetrieval() is true.

getEntryRetrievalSessionForDictionary

EntryRetrievalSession getEntryRetrievalSessionForDictionary(Id dictionaryId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

Gets the OsidSession used to retrieve dictionary entries for the specified Dictionary .

Parameters:

dictionaryId - the Id of the Dictionary to use

proxy - a proxy

Returns:

an EntryRetrievalSession

Throws:

NotFoundException - no Dictionary found by the given Id

NullArgumentException - dictionaryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryRetrieval() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEntryRetrieval(), supportsVisibleFederation() are true.

getEntryLookupSession

EntryLookupSession getEntryLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession used to lookup dictionary entries.

Parameters:

proxy - a proxy

Returns:

an EntryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryLookup() is false

Compliance:

optional - This method must be implemented if supportsEntryLookup() is true.

getEntryLookupSessionForDictionary

EntryLookupSession getEntryLookupSessionForDictionary(Id dictionaryId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

Gets the OsidSession used to lookup dictionary entries for the specified Dictionary .

Parameters:

dictionaryId - the Id of the Dictionary to use

proxy - a proxy

Returns:

an EntryLookupSession

Throws:

NotFoundException - no Dictionary found by the given Id

NullArgumentException - dictionaryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEntryLookup(), supportsVisibleFederation() are true.

getEntryQuerySession

EntryQuerySession getEntryQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession used to query dictionary entries.

Parameters:

proxy - a proxy

Returns:

an EntryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryQuery() is false

Compliance:

optional - This method must be implemented if supportsEntryQuery() is true.

getEntryQuerySessionForDictionary

EntryQuerySession getEntryQuerySessionForDictionary(Id dictionaryId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

Gets the OsidSession used to query dictionary entries for the specified Dictionary .

Parameters:

dictionaryId - the Id of the Dictionary to use

proxy - a proxy

Returns:

an EntryQuerySession

Throws:

NotFoundException - no Dictionary found by the given Id

NullArgumentException - dictionaryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEntryQuery(), supportsVisibleFederation() are true.

getEntrySearchSession

EntrySearchSession getEntrySearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession used to search among dictionary entries.

Parameters:

proxy - a proxy

Returns:

an EntrySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntrySearch() is false

Compliance:

optional - This method must be implemented if supportsEntrySearch() is true.

getEntrySearchSessionForDictionary

EntrySearchSession getEntrySearchSessionForDictionary(Id dictionaryId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

Gets the OsidSession used to search among dictionary entries for the specified Dictionary .

Parameters:

dictionaryId - the Id of the Dictionary to use

proxy - a proxy

Returns:

an EntrySearchSession

Throws:

NotFoundException - no Dictionary found by the given Id

NullArgumentException - dictionaryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntrySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEntrySearch(), supportsVisibleFederation() are true.

getEntryAdminSession

EntryAdminSession getEntryAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession used to administer dictionary entries.

Parameters:

proxy - a proxy

Returns:

an EntryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryAdmin() is false

Compliance:

optional - This method must be implemented if supportsEntryAdmin() is true.

getEntryAdminSessionForDictionary

EntryAdminSession getEntryAdminSessionForDictionary(Id dictionaryId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

Gets the OsidSession used to administer dictionary entries for the specified Dictionary .

Parameters:

dictionaryId - the Id of the Dictionary to use

proxy - a proxy

Returns:

an EntryAdminSession

Throws:

NotFoundException - no Dictionary found by the given Id

NullArgumentException - dictionaryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryAdmin() os supportsVisibleFederration() is false

Compliance:

optional - This method must be implemented if supportsEntryAdmin(), supportsVisibleFederation() are true.

getEntryNotificationSession

EntryNotificationSession getEntryNotificationSession(EntryReceiver entryReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets an EntryNotificationSession which is responsible for subscribing to entry changes within a default Dictionary.

Parameters:

entryReceiver - the notification callback

proxy - a proxy

Returns:

an EntryNotificationSession

Throws:

NullArgumentException - entryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryNotification() is false

Compliance:

optional - This method must be implemented if supportsEntryNotification() is true.

getEntryNotificationSessionForDictionary

EntryNotificationSession getEntryNotificationSessionForDictionary(EntryReceiver entryReceiver,
                                                                Id dictionaryId,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

Gets an EntryNotificationSession which is responsible for subscribing to entry changes for a specified Dictionary.

Parameters:

entryReceiver - the notification callback

dictionaryId - the Id of the Dictionary to use

proxy - a proxy

Returns:

an EntryNotificationSession

Throws:

NotFoundException - no Dictionary found by the given Id

NullArgumentException - entryReceiver, dictionaryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEntryNotification() and supportsVisibleFederation() are true.

getEntryDictionarySession

EntryDictionarySession getEntryDictionarySession(Proxy proxy)
                                                 throws OperationFailedException

Gets the session for retrieving entry to dictionary mappings.

Parameters:

proxy - a proxy

Returns:

a EntryDictionarySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryDictionary() is false

Compliance:

optional - This method must be implemented if supportsEntryDictionary() is 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 - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryDictionaryAssignment() is false

Compliance:

optional - This method must be implemented if supportsEntryDictionaryAssignment() is true.

getEntrySmartDictionarySession

EntrySmartDictionarySession getEntrySmartDictionarySession(Id dictionaryId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the session for managing dynamic entry dictionarys.

Parameters:

dictionaryId - the Id of the dictionary

proxy - a proxy

Returns:

a EntrySmartDictionarySession

Throws:

NotFoundException - dictionaryId not found

NullArgumentException - dictionaryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntrySmartDictionary() is false

Compliance:

optional - This method must be implemented if supportsEntrySmartDictionary() is true.

getDictionaryLookupSession

DictionaryLookupSession getDictionaryLookupSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession used to lookup dictionaries.

Parameters:

proxy - a proxy

Returns:

a DictionaryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDictionaryLookup() is false

Compliance:

optional - This method must be implemented if supportsDictionaryLookup() and supportsVisibleFederation() are true.

getDictionaryQuerySession

DictionaryQuerySession getDictionaryQuerySession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession used to query dictionaries.

Parameters:

proxy - a proxy

Returns:

a DictionaryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDictionaryQuery() is false

Compliance:

optional - This method must be implemented if supportsDictionaryQuery() and supportsVisibleFederation() are true.

getDictionarySearchSession

DictionarySearchSession getDictionarySearchSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession used to search for dictionaries.

Parameters:

proxy - a proxy

Returns:

a DictionarySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDictionarySearch() is false

Compliance:

optional - This method must be implemented if supportsDictionarySearch() and supportsVisibleFederation() are true.

getDictionaryAdminSession

DictionaryAdminSession getDictionaryAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession used to administer dictionaries.

Parameters:

proxy - a proxy

Returns:

a DictionaryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDictionaryAdmin() is false

Compliance:

optional - This method must be implemented if supportsDictionaryAdmin() is true.

getDictionaryNotificationSession

DictionaryNotificationSession getDictionaryNotificationSession(DictionaryReceiver dictionaryReceiver,
                                                             Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession used to subscribe to notifications of new, updated or deleted dictionaries dictionaries.

Parameters:

dictionaryReceiver - the notification callback

proxy - a proxy

Returns:

a DictionaryNotificationSession

Throws:

NullArgumentException - dictionaryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDictionaryNotification() is false

Compliance:

optional - This method must be implemented if supportsDictionaryNotification() is true.

getDictionaryHierarchySession

DictionaryHierarchySession getDictionaryHierarchySession(Proxy proxy)
                                                         throws OperationFailedException

Gets the hierarchy traversing the Dictionary hierarchy. The parent includes all dictionary elements of its children.

Parameters:

proxy - a proxy

Returns:

a DictionaryHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDictionaryHierarchy() is false

Compliance:

optional - This method must be implemented if supportsDictionaryHierarchyTraversal() is true.

getDictionaryHierarchyDesignSession

DictionaryHierarchyDesignSession getDictionaryHierarchyDesignSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the hierarchy managing the Dictionary hierarchy. The parent includes all dictionary elements of its children.

Parameters:

proxy - a proxy

Returns:

a DictionaryHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDictionaryHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsDictionaryHierarchyDesign() is true.

getDictionaryBatchProxyManager

DictionaryBatchProxyManager getDictionaryBatchProxyManager()
                                                           throws OperationFailedException

Gets a DictionaryBatchProxyManager.

Returns:

a DictionaryBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDictionaryBatch() is false

Compliance:

optional - This method must be implemented.