OSID - osid.lexicon.TextAdminSession Service Interface Definition

Interface	osid.lexicon.TextAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.lexicon.batch.TextBatchAdminSession`
Used By	`osid.lexicon.LexiconManager`
Used By	`osid.lexicon.LexiconProxyManager`
Description	This session creates, updates, and deletes `Texts`. 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 a `Text`, a `TextForm` is requested using `getTextFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `TextForm` 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 `TextForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `TextForm` corresponds to an attempted transidiom. For updates, `TextForms` are requested to the `Text` `Id` that is to be updated using `getTextFormForUpdate()`. Similarly, the `TextForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `TextForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Texts`. To unmap a `Text` from the current `Press`, the `TextPressAssignmentSession` should be used. These delete operations attempt to remove the `Text` 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	canCreateTexts
Description	Tests if this user can create `Texts`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Text` 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 `Text` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateTextWithRecordTypes
Description	Tests if this user can create a single `Text` using the desired record types. While `LexiconManager.getTextRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Text`. Providing an empty array tests if a `Text` can be created with no records.
Parameters	`osid.type.Type[]`	`textRecordTypes`	array of text record types
Return	`boolean`		`true` if `Text` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`textRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getTextFormForCreate
Description	Gets the text form for creating new texts. A new form should be requested for each create transidiom.
Parameters	`osid.type.Type[]`	`textRecordTypes`	array of text record types
Return	`osid.lexicon.TextForm`		the text form
Errors	NULL_ARGUMENT		`textRecordTypes` 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	createText
Description	Creates a new `Text`.
Parameters	`osid.lexicon.TextForm`	`textForm`	the form for this `Text`
Return	`osid.lexicon.Text`		the new `Text`
Errors	ILLEGAL_STATE		`textForm` already used in a create transidiom
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`textForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`textForm` did not originate from `getTextFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateTexts
Description	Tests if this user can update `Texts`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Text` 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 `Text` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTextFormForUpdate
Description	Gets the text form for updating an existing text. A new text form should be requested for each update transidiom.
Parameters	`osid.id.Id`	`textId`	the `Id` of the `Text`
Return	`osid.lexicon.TextForm`		the text form
Errors	NOT_FOUND		`textId` is not found
	NULL_ARGUMENT		`textId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateText
Description	Updates an existing text.
Parameters	`osid.lexicon.TextForm`	`textForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`textForm` already used in an update transatcion
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`textForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`textForm` did not originate from `getTextFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteTexts
Description	Tests if this user can delete `Texts`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Text` 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 `Text` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteText
Description	Deletes a `Text`.
Parameters	`osid.id.Id`	`textId`	the `Id` of the `Text` to remove
Errors	NOT_FOUND		`textId` not found
	NULL_ARGUMENT		`textId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageTextAliases
Description	Tests if this user can manage `Id` aliases for `Texts`. 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 `Text` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasText
Description	Adds an `Id` to a `Text` for the purpose of creating compatibility. The primary `Id` of the `Text` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another text, it is reassigned to the given text `Id`.
Parameters	`osid.id.Id`	`textId`	the `Id` of a `Text`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`textId` not found
	NULL_ARGUMENT		`textId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.