OSID - osid.resource.ResourceRelationshipAdminSession Service Interface Definition

Interface	osid.resource.ResourceRelationshipAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.resource.batch.ResourceRelationshipBatchAdminSession`
Used By	`osid.resource.ResourceManager`
Used By	`osid.resource.ResourceProxyManager`
Description	This session creates, updates, and deletes `ResourceRelationships`. 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 `ResourceRelationship`, a `ResourceRelationshipForm` is requested using `geResourceRelationshipFormForCreate()` specifying the `nodes` and desired record `Types` or none if no record `Types` are needed. The returned `ResourceRelationshipForm` 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 `ResourceRelationshipForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ResourceRelationshipForm` corresponds to an attempted transaction. For updates, `ResourceRelationshipForms` are requested to the `ResourceRelationship` `Id` that is to be updated using `getResourceRelationshipFormForUpdate()`. Similarly, the `ResourceRelationshipForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ResourceRelationshipForm` can only be used once for a successful update and cannot be reused. The delete operations delete `ResourceRelationships`. To unmap s `ResourceRelationship` from the current `Bin`, the `ResourceRelationshipBinAssignmentSession` should be used. These delete operations attempt to remove the `ResourceRelationship` 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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateResourceRelationships
Description	Tests if this user can create `ResourceRelationships`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `ResourceRelationship` 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 `ResourceRelationship` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateResourceRelationshipWithRecordTypes
Description	Tests if this user can create a single `ResourceRelationship` using the desired record types. While `ResourceManager.getResourceRelationshipRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `ResourceRelationship`. Providing an empty array tests if a `ResourceRelationship` can be created with no records.
Parameters	`osid.type.Type[]`	`resourceRelationshipRecordTypes`	array of resource relationship types
Return	`boolean`		`true` if `ResourceRelationship` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`resourceRelationshipRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipFormForCreate
Description	Gets the relationship form for creating new relationships. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`sourceResourceId`	the `Id` of the source `Resource`
	`osid.id.Id`	`destinationResourceId`	the `Id` of the destination `Resource`
	`osid.type.Type[]`	`resourceRelationshipRecordTypes`	array of resource relationship types
Return	`osid.resource.ResourceRelationshipForm`		the relationship form
Errors	NOT_FOUND		`sourceResourceId` or `destinationResourceId` is not found
	NULL_ARGUMENT		`resourceId` or `peerResourceId` 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	createResourceRelationship
Description	Creates a new `ResourceRelationship`.
Parameters	`osid.resource.ResourceRelationshipForm`	`resourceRelationshipForm`	the form for this `ResourceRelationship`
Return	`osid.resource.ResourceRelationship`		the new `ResourceRelationship`
Errors	ILLEGAL_STATE		`resourceRelationshipForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`resourceId, peerResourceId` or `resourceRelationshipForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`resourceRelationshipForm` did not originate from `getResourceRelationshipFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateResourceRelationships
Description	Tests if this user can update `ResourceRelationships`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `ResourceRelationship` 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 relationship modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRelationshipFormForUpdate
Description	Gets the relationship form for updating an existing relationship. A new relationship form should be requested for each update transaction.
Parameters	`osid.id.Id`	`resourceRelationshipId`	the `Id` of the `ResourceRelationship`
Return	`osid.resource.ResourceRelationshipForm`		the relationship form
Errors	NOT_FOUND		`resourceRelationshipId` not found
	NULL_ARGUMENT		`resourceRelationshipId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	updateResourceRelationship
Description	Updates an existing relationship.
Parameters	`osid.resource.ResourceRelationshipForm`	`resourceRelationshipForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`resourceRelationshipForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`resourceRelationshipForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`resourceRelationshipForm` did not originate from `getResourceRelationshipFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteResourceRelationships
Description	Tests if this user can delete `ResourceRelationships`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `ResourceRelationship` 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 `ResourceRelationship` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteResourceRelationship
Description	Deletes the `ResourceRelationship` identified by the given `Id`.
Parameters	`osid.id.Id`	`resourceRelationshipId`	the `Id` of the `ResourceRelationship` to delete
Errors	NOT_FOUND		a `ResourceRelationship` was not found identified by the given `Id`
	NULL_ARGUMENT		`resourceRelationshipId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageResourceRelationshipAliases
Description	Tests if this user can manage `Id` aliases for `ResourceRelationships`. 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 `ResourceRelationship` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasResourceRelationship
Description	Adds an `Id` to a `ResourceRelationship` for the purpose of creating compatibility. The primary `Id` of the `ResourceRelationship` 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 relationshp, it is reassigned to the given resource relationship `Id`.
Parameters	`osid.id.Id`	`resourceRelationshipId`	the `Id` of a `ResourceRelationship`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`resourceRelationshipId` not found
	NULL_ARGUMENT		`resourceRelationshipId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.