org.osid.dictionary

Interface DictionaryManager

All Superinterfaces:

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

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

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                               throws OperationFailedException

Gets the OsidSession used to retrieve dictionary entries.

Returns:

the new EntryRetrievalSession

Throws:

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)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

dictionaryId - the Id of the Dictionary to use

Returns:

an EntryRetrievalSession

Throws:

NotFoundException - no Dictionary found by the given Id

NullArgumentException - dictionaryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryRetrieval() or supportsVisibleFederation() is false

Compliance:

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

getEntryLookupSession

EntryLookupSession getEntryLookupSession()
                                         throws OperationFailedException

Gets the OsidSession used to retrieve dictionary entries.

Returns:

an EntryLookupSession

Throws:

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)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

dictionaryId - the Id of the Dictionary to use

Returns:

an EntryLookupSession

Throws:

NotFoundException - no Dictionary found by the given Id

NullArgumentException - dictionaryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryLookup() or supportsVisibleFederation() is false

Compliance:

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

getEntryQuerySession

EntryQuerySession getEntryQuerySession()
                                       throws OperationFailedException

Gets the OsidSession used to query dictionary entries.

Returns:

an EntryQuerySession

Throws:

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)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

dictionaryId - the Id of the Dictionary to use

Returns:

an EntryQuerySession

Throws:

NotFoundException - no Dictionary found by the given Id

NullArgumentException - dictionaryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryQuery() or supportsVisibleFederation() is false

Compliance:

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

getEntrySearchSession

EntrySearchSession getEntrySearchSession()
                                         throws OperationFailedException

Gets the OsidSession used to search dictionary entries.

Returns:

an EntrySearchSession

Throws:

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)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

dictionaryId - the Id of the Dictionary to use

Returns:

an EntrySearchSession

Throws:

NotFoundException - no Dictionary found by the given Id

NullArgumentException - dictionaryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntrySearch() or supportsVisibleFederation() is false

Compliance:

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

getEntryAdminSession

EntryAdminSession getEntryAdminSession()
                                       throws OperationFailedException

Gets the OsidSession used to administer dictionary entries.

Returns:

an EntryAdminSession

Throws:

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)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

dictionaryId - the Id of the Dictionary to use

Returns:

an EntryAdminSession

Throws:

NotFoundException - no Dictionary found by the given Id

NullArgumentException - dictionaryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryAdmin() os supportsVisibleFederration() is false

Compliance:

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

getEntryNotificationSession

EntryNotificationSession getEntryNotificationSession(EntryReceiver entryReceiver)
                                                     throws OperationFailedException

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

Parameters:

entryReceiver - the notification callback

Returns:

an EntryNotificationSession

Throws:

NullArgumentException - entryReceiver 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)
                                                                  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

Returns:

an EntryNotificationSession

Throws:

NotFoundException - no Dictionary found by the given Id

NullArgumentException - entryReceiver or dictionaryId 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()
                                                 throws OperationFailedException

Gets the session for retrieving entry to dictionary mappings.

Returns:

a EntryDictionarySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryDictionary() is false

Compliance:

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

getEntryDictionaryAssignmentSession

EntryDictionaryAssignmentSession getEntryDictionaryAssignmentSession()
                                                                     throws OperationFailedException

Gets the session for assigning entry to dictionary mappings.

Returns:

a EntryDictionaryAssignmentSession

Throws:

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)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the session for managing dynamic entry dictionarys.

Parameters:

dictionaryId - the Id of the dictionary

Returns:

a EntrySmartDictionarySession

Throws:

NotFoundException - dictionaryId not found

NullArgumentException - dictionaryId 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()
                                                   throws OperationFailedException

Gets the OsidSession used to lookup dictionaries.

Returns:

a DictionaryLookupSession

Throws:

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()
                                                 throws OperationFailedException

Gets the OsidSession used to query dictionaries.

Returns:

a DictionaryQuerySession

Throws:

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()
                                                   throws OperationFailedException

Gets the OsidSession used to search dictionaries.

Returns:

a DictionarySearchSession

Throws:

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()
                                                 throws OperationFailedException

Gets the OsidSession used to administer dictionaries

Returns:

a DictionaryAdminSession

Throws:

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)
                                                               throws OperationFailedException

Gets the OsidSession used to receive notifications of dictionary changes.

Parameters:

dictionaryReceiver - the notification callback

Returns:

a DictionaryNotificationSession

Throws:

NullArgumentException - dictionaryReceiver 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()
                                                         throws OperationFailedException

Gets hierarchy service for traversing the Dictionary hierarchy. A parent includes all the dictionary entries of its children.

Returns:

a Dictionary HierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDictionaryHierarchyTraversal() is false

Compliance:

optional - This method must be implemented.

getDictionaryHierarchyDesignSession

DictionaryHierarchyDesignSession getDictionaryHierarchyDesignSession()
                                                                     throws OperationFailedException

Gets hierarchy service for structuring Dictionary objects.

Returns:

a DictionaryHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDictionaryHierarchyDesign() is false

Compliance:

optional - This method must be implemented.

getDictionaryBatchManager

DictionaryBatchManager getDictionaryBatchManager()
                                                 throws OperationFailedException

Gets a DictionaryBatchManager.

Returns:

a DictionaryBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDictionaryBatch() is false

Compliance:

optional - This method must be implemented.