OSID - osid.lexicon.IdiomAdminSession Service Interface Definition

Interface	osid.lexicon.IdiomAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.lexicon.batch.IdiomBatchAdminSession`
Used By	`osid.lexicon.LexiconManager`
Used By	`osid.lexicon.LexiconProxyManager`
Description	This session creates, updates, and deletes `Idioms` . The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create an `Idiom` , an `IdiomForm` is requested using `getIdiomFormForCreate()` specifying the desired text and record `Types` or none if no record `Types` are needed. The returned `IdiomForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `IdiomForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `IdiomForm` corresponds to an attempted transidiom. For updates, `IdiomForms` are requested to the `Idiom` `Id` that is to be updated using `getIdiomFormForUpdate()` . Similarly, the `IdiomForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `IdiomForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Idioms` . To unmap an `Idiom` from the current `Press` , the `IdiomPressAssignmentSession` should be used. These delete operations attempt to remove the `Idiom` itself thus removing it from all known `Press` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getPressId
Description	Gets the `Press` `Id` associated with this session.
Return	`osid.id.Id`		the `Press Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPress
Description	Gets the `Press` associated with this session.
Return	`osid.lexicon.Press`		the press
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateIdioms
Description	Tests if this user can create `Idioms` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Idiom` 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 `Idiom` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateIdiomWithRecordTypes
Description	Tests if this user can create a single `Idiom` using the desired record types. While `LexiconManager.getIdiomRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Idiom` . Providing an empty array tests if an `Idiom` can be created with no records.
Parameters	`osid.type.Type[]`	`idiomRecordTypes`	array of idiom record types
Return	`boolean`		`true` if `Idiom` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`idiomRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIdiomFormForCreate
Description	Gets the idiom form for creating new idioms. A new form should be requested for each create transidiom.
Parameters	`osid.id.Id`	`textId`	a text `Id`
Parameters	`osid.type.Type[]`	`idiomRecordTypes`	array of idiom record types
Return	`osid.lexicon.IdiomForm`		the idiom form
Errors	NOT_FOUND		`textId` is not found
	NULL_ARGUMENT		`textId` or `idiomRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createIdiom
Description	Creates a new `Idiom` .
Parameters	`osid.lexicon.IdiomForm`	`idiomForm`	the form for this `Idiom`
Return	`osid.lexicon.Idiom`		the new `Idiom`
Errors	ILLEGAL_STATE		`idiomForm` already used in a create transidiom
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`idiomForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`idiomForm` did not originate from `getIdiomFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateIdioms
Description	Tests if this user can update `Idioms` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Idiom` 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 `Idiom` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIdiomFormForUpdate
Description	Gets the idiom form for updating an existing idiom. A new idiom form should be requested for each update transidiom.
Parameters	`osid.id.Id`	`idiomId`	the `Id` of the `Idiom`
Return	`osid.lexicon.IdiomForm`		the idiom form
Errors	NOT_FOUND		`idiomId` is not found
	NULL_ARGUMENT		`idiomId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateIdiom
Description	Updates an existing idiom.
Parameters	`osid.lexicon.IdiomForm`	`idiomForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`idiomForm` already used in an update transidiom
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`idiomForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`idiomForm` did not originate from `getIdiomFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteIdioms
Description	Tests if this user can delete `Idioms` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Idiom` 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 `Idiom` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteIdiom
Description	Deletes an `Idiom` .
Parameters	`osid.id.Id`	`idiomId`	the `Id` of the `Idiom` to remove
Errors	NOT_FOUND		`idiomId` not found
	NULL_ARGUMENT		`idiomId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageIdiomAliases
Description	Tests if this user can manage `Id` aliases for `Idioms` . 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 `Idiom` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasIdiom
Description	Adds an `Id` to an `Idiom` for the purpose of creating compatibility. The primary `Id` of the `Idiom` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another idiom, it is reassigned to the given idiom `Id` .
Parameters	`osid.id.Id`	`idiomId`	the `Id` of an `Idiom`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`idiomId` not found
	NULL_ARGUMENT		`idiomId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.