OSID - osid.hold.OublietteAdminSession Service Interface Definition

Interface	osid.hold.OublietteAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Oubliettes.` 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 `Oubliette,` a `OublietteForm` is requested using `getOublietteFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `OublietteForm` 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 `OublietteForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `OublietteForm` corresponds to an attempted transaction. For updates, `OublietteForms` are requested to the `Oubliette` `Id` that is to be updated using `getOublietteFormForUpdate().` Similarly, the `OublietteForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `OublietteForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Oubliettes.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateOubliette
Description	Tests if this user can create `Oubliettes.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Oubliette.` 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 `Oubliette` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateOublietteWithRecordTypes
Description	Tests if this user can create a single `Oubliette` using the desired record types. While `HoldManager.getOublietteRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Oubliette.` Providing an empty array tests if a `Oubliette` can be created with no records.
Parameters	`osid.type.Type[]`	`oublietteRecordTypes`	array of oubliette record types
Return	`boolean`		`true` if `Oubliette` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`oublietteRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOublietteFormForCreate
Description	Gets the oubliette form for creating new oubliettes. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`oublietteRecordTypes`	array of oubliette record types
Return	`osid.hold.OublietteForm`		the oubliette form
Errors	NULL_ARGUMENT		`oublietteRecordTypes` 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	createOubliette
Description	Creates a new `Oubliette.`
Parameters	`osid.hold.OublietteForm`	`oublietteForm`	the form for this `Oubliette`
Return	`osid.hold.Oubliette`		the new `Oubliette`
Errors	ILLEGAL_STATE		`oublietteForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`oublietteForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`oublietteForm` did not originate from `getOublietteFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateOubliettes
Description	Tests if this user can update `Oubliettes.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Oubliette` 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 `Oubliette` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOublietteFormForUpdate
Description	Gets the oubliette form for updating an existing oubliette. A new oubliette form should be requested for each update transaction.
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of the `Oubliette`
Return	`osid.hold.OublietteForm`		the oubliette form
Errors	NOT_FOUND		`oublietteId` is not found
	NULL_ARGUMENT		`oublietteId` is `null`
	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	updateOubliette
Description	Updates an existing oubliette.
Parameters	`osid.hold.OublietteForm`	`oublietteForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`oublietteForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`oublietteForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`oublietteForm` did not originate from `getOublietteFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteOubliettes
Description	Tests if this user can delete `Oubliettes.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Oubliette` 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 `Oubliette` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteOubliette
Description	Deletes a `Oubliette.`
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of the `Oubliette` to remove
Errors	NOT_FOUND		`oublietteId` not found
	NULL_ARGUMENT		`oublietteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageOublietteAliases
Description	Tests if this user can manage `Id` aliases for `Oubliettes.` 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 `Oubliette` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasOubliette
Description	Adds an `Id` to a `Oubliette` for the purpose of creating compatibility. The primary `Id` of the `Oubliette` is determined by the provider. The new `Id` performs as an alias to the primary `Id.`
Parameters	`osid.id.Id`	`oublietteId`	the `Id` of a `Oubliette`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`oublietteId` not found
	NULL_ARGUMENT		`oublietteId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.