Interface DictionaryManager

All Superinterfaces:

AutoCloseable, Closeable, DictionaryProfile, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

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, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getDictionaryRecordTypes()	Gets the supported Dictionary record types.
TypeList	getDictionarySearchRecordTypes()	Gets the supported Dictionary search record types.
TypeList	getEntryKeyTypes()	Gets the supported Entry key types.
TypeList	getEntryRecordTypes()	Gets the supported Entry record types.
TypeList	getEntrySearchRecordTypes()	Gets the supported Entry search record types.
TypeList	getEntryValueTypes()	Gets the supported Entry value types.
TypeList	getEntryValueTypesForKeyType(Type entryKeyType)	Gets the list of value types supported for the given key type.
boolean	supportsDictionaryAdmin()	Tests if a dictionary administrative service is supported.
boolean	supportsDictionaryBatch()	Tests if a dictionary batch service is supported.
boolean	supportsDictionaryHierachyDesign()	Tests if a dictionary hierarchy design service is supported.
boolean	supportsDictionaryHierachyTraversal()	Tests if a dictionary hierarchy traversal service is supported.
boolean	supportsDictionaryLookup()	Tests if a dictionary lookup service is supported.
boolean	supportsDictionaryNotification()	Tests if a dictionary notification service is supported.
boolean	supportsDictionaryQuery()	Tests if a dictionary query service is supported.
boolean	supportsDictionaryRecordType(Type dictionaryRecordType)	Tests if the given Dictionary record type is supported.
boolean	supportsDictionarySearch()	Tests if a dictionary search service is supported.
boolean	supportsDictionarySearchRecordType(Type dictionarySearchRecordType)	Tests if the given Dictionary search record type is supported.
boolean	supportsEntryAdmin()	Tests if a dictionary entry administrative service is supported.
boolean	supportsEntryDictionary()	Tests if retrieving mappings of entry and dictionarys is supported.
boolean	supportsEntryDictionaryAssignment()	Tests if managing mappings of entry and dictionarys is supported.
boolean	supportsEntryKeyType(Type entryKeyType)	Tests if the given Entry key type is supported.
boolean	supportsEntryLookup()	Tests if looking up dictionary entries are supported.
boolean	supportsEntryNotification()	Tests if a dictionary entry notification service is supported.
boolean	supportsEntryQuery()	Tests if querying dictionary entries are supported.
boolean	supportsEntryRecordType(Type entryRecordType)	Tests if the given Entry record type is supported.
boolean	supportsEntryRetrieval()	Tests if retrieving dictionary entries are supported.
boolean	supportsEntrySearch()	Tests if searching dictionary entries are supported.
boolean	supportsEntrySearchRecordType(Type entrySearchRecordType)	Tests if the given Entry search record type is supported.
boolean	supportsEntrySmartDictionary()	Tests if entry smart dictionarys are available.
boolean	supportsEntryTypes(Type entryKeyType, Type entryValueType)	Tests if the given Entry key and value types are supported.
boolean	supportsEntryValueType(Type entryValueType)	Tests if the given Entry value type is supported.
boolean	supportsVisibleFederation()	Tests if any dictionary federation is exposed.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsEntryRetrieval()} is {@code 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 {@code supportsEntryRetrieval()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEntryLookup()} is {@code 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 {@code supportsEntryLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEntryQuery()} is {@code 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 {@code supportsEntryQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEntrySearch()} is {@code 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 {@code supportsEntrySearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEntryAdmin()} is {@code 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 {@code supportsEntryAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEntryNotification()} is {@code 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 {@code supportsEntryNotification ()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEntryDictionary()} is {@code 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 {@code supportsEntryDictionaryAssignment()} is {@code 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 {@code supportsEntrySmartDictionary()} is {@code 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 {@code supportsDictionaryLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDictionaryQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDictionarySearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDictionaryAdmin()} is {@code 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 {@code supportsDictionaryNotification()} is {@code 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.