OSID - osid.dictionary.EntryDictionaryAssignmentSession Service Interface Definition

Interface	osid.dictionary.EntryDictionaryAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.dictionary.DictionaryManager`
Used By	`osid.dictionary.DictionaryProxyManager`
Description	This session provides methods to re-assign enrties to dictionaries. An `Entry` may map to multiple `Dictionaries` and removing the last reference to an `Entry` is the equivalent of deleting it. Each `Dictionary` may have its own authorizations governing who is allowed to operate on it. Moving or adding a reference of an `Entry` to another `Dictionary` is not a copy operation (eg: does not change its `Id`).
Method	canAssignEntries
Description	Tests if this user can alter entry/dictionary mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignEntriesToDictionary
Description	Tests if this user can alter entry/dictionary mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`dictionaryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableDictionaryIds
Description	Gets a list of dictionaries including and under the given dictionary node in which any entry can be assigned.
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary`
Return	`osid.id.IdList`		list of assignable dictionary `Ids`
Errors	NULL_ARGUMENT		`dictionaryId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableDictionaryIdsForEntry
Description	Gets a list of dictionaries including and under the given dictionary node in which a specific entry can be assigned.
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary`
Parameters	`osid.id.Id`	`entryId`	the `Id` of the `Entry`
Return	`osid.id.IdList`		list of assignable dictionary `Ids`
Errors	NULL_ARGUMENT		`dictionaryId` or `entryId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignEntryToDictionary
Description	Adds an existing `Entry` to a `Dictionary`.
Parameters	`osid.id.Id`	`entryId`	the `Id` of the `Entry`
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary`
Errors	ALREADY_EXISTS		`entryId` is already assigned to `dictionaryId`
	NOT_FOUND		`entryId` or `dictionaryId` not found
	NULL_ARGUMENT		`entryId` or `dictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignEntryFromDictionary
Description	Removes an `Entry` from a `Dictionary`.
Parameters	`osid.id.Id`	`entryId`	the `Id` of the `Entry`
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary`
Errors	NOT_FOUND		`entryId` or `dictionaryId` not found or `entryId` not assigned to `dictionaryId`
	NULL_ARGUMENT		`entryId` or `dictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignEntryToDictionary
Description	Moves an `Entry` from one `Dictionary` to another. Mappings to other `Dictionaries` are unaffected.
Parameters	`osid.id.Id`	`entryId`	the `Id` of the `Entry`
	`osid.id.Id`	`fromDictionaryId`	the `Id` of the current `Dictionary`
	`osid.id.Id`	`toDictionaryId`	the `Id` of the destination `Dictionary`
Errors	ALREADY_EXISTS		`entryId` already assigned to `toDictionaryId`
	NOT_FOUND		`entryId, fromDictionaryId`, or `toDictionaryId` not found or `entryId` not mapped to `fromDictionaryId`
	NULL_ARGUMENT		`entryId fromDictionaryId`, or `toDictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.