OSID - osid.search.EngineAdminSession Service Interface Definition

Interface	osid.search.EngineAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Engines.` 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 `Engine,` an `EngineForm` is requested using `getEngineFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `EngineForm` 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 `EngineForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `EngineForm` corresponds to an attempted transaction. For updates, `EngineForms` are requested to the `Engine` `Id` that is to be updated using `getEngineFormForUpdate().` Similarly, the `EngineForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `EngineForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Engines.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateEngines
Description	Tests if this user can create `Engines.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Engine` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Engine` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateEngineWithRecordTypes
Description	Tests if this user can create a single `Engine` using the desired record types. While `SearchManager.getEngineRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Engine.` Providing an empty array tests if an `Engine` can be created with no records.
Parameters	`osid.type.Type[]`	`engineRecordTypes`	array of engine record types
Return	`boolean`		`true` if `Engine` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`engineRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEngineFormForCreate
Description	Gets the engine form for creating new engines. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`engineRecordTypes`	array of engine record types
Return	`osid.search.EngineForm`		the engine form
Errors	NULL_ARGUMENT		`engineRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get a form with given record types
Compliance	`mandatory`		This method must be implemented.
Method	createEngine
Description	Creates a new `Engine.`
Parameters	`osid.search.EngineForm`	`engineForm`	the form for this `Engine`
Return	`osid.search.Engine`		the new `Engine`
Errors	ILLEGAL_STATE		`engineForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`engineForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`engineForm` did not originate from `getEngineFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateEngines
Description	Tests if this user can update `Engines.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Engine` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Engine` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEngineFormForUpdate
Description	Gets the engine form for updating an existing engine. A new engine form should be requested for each update transaction.
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine`
Return	`osid.search.EngineForm`		the engine form
Errors	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateEngine
Description	Updates an existing engine.
Parameters	`osid.search.EngineForm`	`engineForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`engineForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`engineId` or `engineForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`engineForm` did not originate from `getEngineFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteEngines
Description	Tests if this user can delete `Engines.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Engine` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Engine` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteEngine
Description	Deletes an `Engine.`
Parameters	`osid.id.Id`	`engineId`	the `Id` of the `Engine` to remove
Errors	NOT_FOUND		`engineId` not found
	NULL_ARGUMENT		`engineId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageEngineAliases
Description	Tests if this user can manage `Id` aliases for `Engines.` 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 `Engine` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasEngine
Description	Adds an `Id` to an `Engine` for the purpose of creating compatibility. The primary `Id` of the `Engine` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another engine, it is reassigned to the given engine `Id.`
Parameters	`osid.id.Id`	`engineId`	the `Id` of an `Engine`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`engineId` not found
	NULL_ARGUMENT		`engineId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.