OSID - osid.resource.ResourceAdminSession Service Interface Definition

Interface	osid.resource.ResourceAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.resource.batch.ResourceBatchAdminSession`
Used By	`osid.resource.ResourceManager`
Used By	`osid.resource.ResourceProxyManager`
Description	This session creates, updates, and deletes `Resources`. 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 `Resource`, a `ResourceForm` is requested using `getResourceFormForCreate()` specifying desired record `Types` or none if no record `Types` are needed. The returned `ResourceForm` 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 `ResourceForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ResourceForm` corresponds to an attempted transaction. For updates, `ResourceForms` are requested to the `Resource` `Id` that is to be updated using `getResourceFormForUpdate()`. Similarly, the `ResourceForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ResourceForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Resources`. To unmap a `Resource` from the current `Bin`, the `ResourceBinAssignmentSession` should be used. These delete operations attempt to remove the `Resource` itself thus removing it from all known `Bin` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getBinId
Description	Gets the `Bin` `Id` associated with this session.
Return	`osid.id.Id`		the `Bin Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBin
Description	Gets the `Bin` associated with this session.
Return	`osid.resource.Bin`		the `Bin` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateResources
Description	Tests if this user can create `Resources`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Resource` 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 `Resource` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateResourceWithRecordTypes
Description	Tests if this user can create a single `Resource` using the desired record types. While `ResourceManager.getResourceRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Resource`. Providing an empty array tests if a `Resource` can be created with no records.
Parameters	`osid.type.Type[]`	`resourceRecordTypes`	array of resource record types
Return	`boolean`		`true` if `Resource` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`resourceRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getResourceFormForCreate
Description	Gets the resource form for creating new resources. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`resourceRecordTypes`	array of resource record types
Return	`osid.resource.ResourceForm`		the resource form
Errors	NULL_ARGUMENT		`resourceRecordTypes` 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	createResource
Description	Creates a new `Resource`.
Parameters	`osid.resource.ResourceForm`	`resourceForm`	the form for this `Resource`
Return	`osid.resource.Resource`		the new `Resource`
Errors	ILLEGAL_STATE		`resourceForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`resourceForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`resourceForm` did not originate from `getResourceFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateResources
Description	Tests if this user can update `Resources`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Resource` 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 `Resource` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceFormForUpdate
Description	Gets the resource form for updating an existing resource. A new resource form should be requested for each update transaction.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource`
Return	`osid.resource.ResourceForm`		the resource form
Errors	NOT_FOUND		`resourceId` is not found
	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateResource
Description	Updates an existing resource.
Parameters	`osid.resource.ResourceForm`	`resourceForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`resourceForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`resourceForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`resourceForm` did not originate from `getResourceFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteResources
Description	Tests if this user can delete `Resources`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Resource` 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 `Resource` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteResource
Description	Deletes a `Resource`.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to remove
Errors	NOT_FOUND		`resourceId` not found
	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageResourceAliases
Description	Tests if this user can manage `Id` aliases for `Resources`. 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 `Resource` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasResource
Description	Adds an `Id` to a `Resource` for the purpose of creating compatibility. The primary `Id` of the `Resource` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another resource it is reassigned to the given resource `Id`.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of a `Resource`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`resourceId` not found
	NULL_ARGUMENT		`aliasId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.