OSID - osid.dictionary.DictionaryManager Service Interface Definition

Interface	osid.dictionary.DictionaryManager
Implements	`osid.OsidManager`
Implements	`osid.dictionary.DictionaryProfile`
Description	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	getEntryRetrievalSession
Description	Gets the `OsidSession` used to retrieve dictionary entries.
Return	`osid.dictionary.EntryRetrievalSession`		the new `EntryRetrievalSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEntryRetrieval()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryRetrieval()` is `true.`
Method	getEntryRetrievalSessionForDictionary
Description	Gets the `OsidSession` used to retrieve dictionary entries for the specified `Dictionary.`
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary` to use
Return	`osid.dictionary.EntryRetrievalSession`		an `EntryRetrievalSession`
Errors	NOT_FOUND		no `Dictionary` found by the given `Id`
	NULL_ARGUMENT		`dictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEntryRetrieval()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryRetrieval()` and `supportsVisibleFederation()` are `true.`
Method	getEntryLookupSession
Description	Gets the `OsidSession` used to retrieve dictionary entries.
Return	`osid.dictionary.EntryLookupSession`		an `EntryLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEntryLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryLookup()` is `true.`
Method	getEntryLookupSessionForDictionary
Description	Gets the `OsidSession` used to lookup dictionary entries for the specified `Dictionary.`
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary` to use
Return	`osid.dictionary.EntryLookupSession`		an `EntryLookupSession`
Errors	NOT_FOUND		no `Dictionary` found by the given `Id`
	NULL_ARGUMENT		`dictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEntryLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryLookup()` and `supportsVisibleFederation()` are `true.`
Method	getEntryQuerySession
Description	Gets the `OsidSession` used to query dictionary entries.
Return	`osid.dictionary.EntryQuerySession`		an `EntryQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryQuery()` is `true.`
Method	getEntryQuerySessionForDictionary
Description	Gets the `OsidSession` used to query dictionary entries for the specified `Dictionary.`
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary` to use
Return	`osid.dictionary.EntryQuerySession`		an `EntryQuerySession`
Errors	NOT_FOUND		no `Dictionary` found by the given `Id`
	NULL_ARGUMENT		`dictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEntryQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryQuery()` and `supportsVisibleFederation()` are `true.`
Method	getEntrySearchSession
Description	Gets the `OsidSession` used to search dictionary entries.
Return	`osid.dictionary.EntrySearchSession`		an `EntrySearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEntrySearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntrySearch()` is `true.`
Method	getEntrySearchSessionForDictionary
Description	Gets the `OsidSession` used to search dictionary entries for the specified `Dictionary.`
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary` to use
Return	`osid.dictionary.EntrySearchSession`		an `EntrySearchSession`
Errors	NOT_FOUND		no `Dictionary` found by the given `Id`
	NULL_ARGUMENT		`dictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEntrySearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntrySearch()` and `supportsVisibleFederation()` are `true.`
Method	getEntryAdminSession
Description	Gets the `OsidSession` used to administer dictionary entries.
Return	`osid.dictionary.EntryAdminSession`		an `EntryAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEntryAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryAdmin()` is `true.`
Method	getEntryAdminSessionForDictionary
Description	Gets the `OsidSession` used to administer dictionary entries for the specified `Dictionary.`
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary` to use
Return	`osid.dictionary.EntryAdminSession`		an `EntryAdminSession`
Errors	NOT_FOUND		no `Dictionary` found by the given `Id`
	NULL_ARGUMENT		`dictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEntryAdmin()` os `supportsVisibleFederration()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getEntryNotificationSession
Description	Gets an `EntryNotificationSession` which is responsible for subscribing to entry changes within a default `Dictionary.`
Parameters	`osid.dictionary.EntryReceiver`	`entryReceiver`	the notification callback
Return	`osid.dictionary.EntryNotificationSession`		an `EntryNotificationSession`
Errors	NULL_ARGUMENT		`entryReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEntryNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryNotification()` is `true.`
Method	getEntryNotificationSessionForDictionary
Description	Gets an `EntryNotificationSession` which is responsible for subscribing to entry changes for a specified `Dictionary.`
Parameters	`osid.dictionary.EntryReceiver`	`entryReceiver`	the notification callback
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary` to use
Return	`osid.dictionary.EntryNotificationSession`		an `EntryNotificationSession`
Errors	NOT_FOUND		no `Dictionary` found by the given `Id`
	NULL_ARGUMENT		`entryReceiver` or `dictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEntryNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryNotification ()` and `supportsVisibleFederation()` are `true.`
Method	getEntryDictionarySession
Description	Gets the session for retrieving entry to dictionary mappings.
Return	`osid.dictionary.EntryDictionarySession`		a `EntryDictionarySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEntryDictionary()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryDictionary()` is `true.`
Method	getEntryDictionaryAssignmentSession
Description	Gets the session for assigning entry to dictionary mappings.
Return	`osid.dictionary.EntryDictionaryAssignmentSession`		a `EntryDictionaryAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEntryDictionaryAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryDictionaryAssignment()` is `true.`
Method	getEntrySmartDictionarySession
Description	Gets the session for managing dynamic entry dictionarys.
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the dictionary
Return	`osid.dictionary.EntrySmartDictionarySession`		a `EntrySmartDictionarySession`
Errors	NOT_FOUND		`dictionaryId` not found
	NULL_ARGUMENT		`dictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsEntrySmartDictionary()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntrySmartDictionary()` is `true.`
Method	getDictionaryLookupSession
Description	Gets the `OsidSession` used to lookup dictionaries.
Return	`osid.dictionary.DictionaryLookupSession`		a `DictionaryLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDictionaryLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDictionaryLookup()` and `supportsVisibleFederation()` are `true.`
Method	getDictionaryQuerySession
Description	Gets the `OsidSession` used to query dictionaries.
Return	`osid.dictionary.DictionaryQuerySession`		a `DictionaryQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDictionaryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDictionaryQuery()` and `supportsVisibleFederation()` are `true.`
Method	getDictionarySearchSession
Description	Gets the `OsidSession` used to search dictionaries.
Return	`osid.dictionary.DictionarySearchSession`		a `DictionarySearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDictionarySearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDictionarySearch()` and `supportsVisibleFederation()` are `true.`
Method	getDictionaryAdminSession
Description	Gets the `OsidSession` used to administer dictionaries
Return	`osid.dictionary.DictionaryAdminSession`		a `DictionaryAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDictionaryAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDictionaryAdmin()` is `true.`
Method	getDictionaryNotificationSession
Description	Gets the `OsidSession` used to receive notifications of dictionary changes.
Parameters	`osid.dictionary.DictionaryReceiver`	`dictionaryReceiver`	the notification callback
Return	`osid.dictionary.DictionaryNotificationSession`		a `DictionaryNotificationSession`
Errors	NULL_ARGUMENT		`dictionaryReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDictionaryNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDictionaryNotification()` is `true.`
Method	getDictionaryHierarchySession
Description	Gets hierarchy service for traversing the `Dictionary` hierarchy. A parent includes all the dictionary entries of its children.
Return	`osid.dictionary.DictionaryHierarchySession`		a Dictionary `HierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDictionaryHierarchyTraversal()` is `false`
Compliance	`optional`		This method must be implemented.
Method	getDictionaryHierarchyDesignSession
Description	Gets hierarchy service for structuring `Dictionary` objects.
Return	`osid.dictionary.DictionaryHierarchyDesignSession`		a `DictionaryHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDictionaryHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented.
Method	getDictionaryBatchManager
Description	Gets a `DictionaryBatchManager.`
Return	`osid.dictionary.batch.DictionaryBatchManager`		a `DictionaryBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDictionaryBatch()` is `false`
Compliance	`optional`		This method must be implemented.