OSID - osid.dictionary.EntryAdminSession Service Interface Definition

Interface	osid.dictionary.EntryAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.dictionary.batch.EntryBatchAdminSession`
Used By	`osid.dictionary.DictionaryManager`
Used By	`osid.dictionary.DictionaryProxyManager`
Description	`EntryAdminSession` creates, updates and deletes dictionary entries.
Method	getDictionaryId
Description	Gets the `Dictionary` `Id` associated with this session.
Return	`osid.id.Id`		the `Dictionary` `Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getDictionary
Description	Gets the `Dictionary` associated with this session.
Return	`osid.dictionary.Dictionary`		the `Dictionary` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateEntries
Description	Tests if this user can create entries A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Entry` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if entry creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateEntryWithRecordTypes
Description	Tests if this user can create a single `Entry` using the desired record types. While `DictionaryManager.getEntryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Entry`. Providing an empty array tests if an `Entry` can be created with no records.
Parameters	`osid.type.Type[]`	`entryRecordTypes`	array of entry record types
Return	`boolean`		`true` if `Entry` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`entryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEntryFormForCreate
Description	Gets the entry form for creating new inquiries. A new form should be requested for each create transaction.
Parameters	`osid.type.Type`	`keyType`	the `Type` of the key
	`object`	`key`	the key
	`osid.type.Type`	`valueType`	the `Type` of the value
	`osid.type.Type[]`	`entryRecordTypes`	array of entry record types
Return	`osid.dictionary.EntryForm`		the entry form
Errors	ALREADY_EXISTS		an entry by this `key`, `keyType`, and `valueType` already exists
	NULL_ARGUMENT		`keyType, key, valueType`, or `entryRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested key/value or record types
Compliance	`mandatory`		This method must be implemented.
Method	createEntry
Description	Creates a new `Entry`.
Parameters	`osid.dictionary.EntryForm`	`entryForm`	the form for this entry
Return	`osid.dictionary.Entry`		the created entry
Errors	ILLEGAL_STATE		`entryForm` already used in a create transaction.
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`entryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`entryForm` did not originate from `getEntryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateEntries
Description	Tests if this user can update entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Entry` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if entry modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEntryFormForUpdate
Description	Gets the entry form for updating an existing entry. A new entry form should be requested for each update transaction.
Parameters	`osid.id.Id`	`entryId`	the `Id` of the `Entry`
Return	`osid.dictionary.EntryForm`		the entry form
Errors	NOT_FOUND		`entryId` is not found
	NULL_ARGUMENT		`entryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateEntry
Description	Updates an existing `Entry`.
Parameters	`osid.dictionary.EntryForm`	`entryForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`entryForm` already used in an update transatcion
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`entryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`entryyForm` did not originate from `getEntryFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteEntries
Description	Tests if this user can delete `Entries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Entry` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Entry` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteEntry
Description	Updates an existing `Dictionary` entry identified with the specified key with the given value.
Parameters	`osid.id.Id`	`entryId`	the `Id` of the entry
Errors	NOT_FOUND		entry is not found
	NULL_ARGUMENT		`entryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageEntryAliases
Description	Tests if this user can manage `Id` aliases for `Entries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Entry` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasEntry
Description	Adds an `Id` to an `Entry` for the purpose of creating compatibility. The primary `Id` of the `Entry` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another entry, it is reassigned to the given entry `Id`.
Parameters	`osid.id.Id`	`entryId`	the `Id` of an `Entry`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`entryId` not found
	NULL_ARGUMENT		`entryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.