OSID - osid.resource.BinAdminSession Service Interface Definition

Interface	osid.resource.BinAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Bins.` 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 `Bin,` a `BinForm` is requested using `getBinFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `BinForm` 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 `BinForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `BinForm` corresponds to an attempted transaction. For updates, `BinForms` are requested to the `Bin` `Id` that is to be updated using `getBinFormForUpdate().` Similarly, the `BinForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `BinForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Bins.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateBins
Description	Tests if this user can create `Bins.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Bin` 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 `Bin` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateBinWithRecordTypes
Description	Tests if this user can create a single `Bin` using the desired record types. While `ResourceManager.getBinRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Bin.` Providing an empty array tests if a `Bin` can be created with no records.
Parameters	`osid.type.Type[]`	`binRecordTypes`	array of bin record types
Return	`boolean`		`true` if `Bin` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`binRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBinFormForCreate
Description	Gets the bin form for creating new bins.
Parameters	`osid.type.Type[]`	`binRecordTypes`	array of bin record types
Return	`osid.resource.BinForm`		the bin form
Errors	NULL_ARGUMENT		`binRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form with requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createBin
Description	Creates a new `Bin.`
Parameters	`osid.resource.BinForm`	`binForm`	the form for this `Bin`
Return	`osid.resource.Bin`		the new `Bin`
Errors	ILLEGAL_STATE		`binForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`binForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`binForm` did not originate from `getBinFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateBins
Description	Tests if this user can update `Bins.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Bin` 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 `Bin` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBinFormForUpdate
Description	Gets the bin form for updating an existing bin. A new bin form should be requested for each update transaction.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.BinForm`		the bin form
Errors	NOT_FOUND		`binId` is not found
	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateBin
Description	Updates an existing bin.
Parameters	`osid.resource.BinForm`	`binForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`binForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`binId` or `binForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`binForm` did not originate from `getBinFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteBins
Description	Tests if this user can delete `Bins.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Bin` 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 `Bin` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteBin
Description	Deletes a `Bin.`
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin` to remove
Errors	NOT_FOUND		`binId` not found
	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageBinAliases
Description	Tests if this user can manage `Id` aliases for `Bins.` 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 `Bin` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasBin
Description	Adds an `Id` to a `Bin` for the purpose of creating compatibility. The primary `Id` of the `Bin` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another bin, it is reassigned to the given bin `Id.`
Parameters	`osid.id.Id`	`binId`	the `Id` of a `Bin`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`binId` not found
	NULL_ARGUMENT		`binId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.