OSID - osid.relationship.rules.RelationshipEnablerAdminSession Service Interface Definition

Interface	osid.relationship.rules.RelationshipEnablerAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `RelationshipEnablers.` 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 `RelationshipEnabler,` a `RelationshipEnablerForm` is requested using `getRelationshipEnablerFormForCreate()` specifying desired record `Types` or none if no record `Types` are needed. The returned `RelationshipEnablerForm` 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 `RelationshipEnablerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RelationshipEnablerForm` corresponds to an attempted transaction. For updates, `RelationshipEnablerForms` are requested to the `RelationshipEnabler` `Id` that is to be updated using `getRelationshipEnablerFormForUpdate().` Similarly, the `RelationshipEnablerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `RelationshipEnablerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `RelationshipEnablers.` To unmap a `RelationshipEnabler` from the current `Family,` the `RelationshipEnablerFamilyAssignmentSession` should be used. These delete operations attempt to remove the `Node` itself thus removing it from all known `Family` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getFamilyId
Description	Gets the `Family` `Id` associated with this session.
Return	`osid.id.Id`		the `Family Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFamily
Description	Gets the `Family` associated with this session.
Return	`osid.relationship.Family`		the family
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRelationshipEnabler
Description	Tests if this user can create relationship enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `RelationshipEnabler` 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 `RelationshipEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRelationshipEnablerWithRecordTypes
Description	Tests if this user can create a single `RelationshipEnabler` using the desired record types. While `RelationshipRulesManager.getRelationshipEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `RelationshipEnabler.` Providing an empty array tests if a `RelationshipEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`relationshipEnablerRecordTypes`	array of relationship enabler record types
Return	`boolean`		`true` if `RelationshipEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`relationshipEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablerFormForCreate
Description	Gets the relationship enabler form for creating new relationship enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`relationshipEnablerRecordTypes`	array of relationship enabler record types
Return	`osid.relationship.rules.RelationshipEnablerForm`		the relationship enabler form
Errors	NULL_ARGUMENT		`relationshipEnablerRecordTypes` 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	createRelationshipEnabler
Description	Creates a new `RelationshipEnabler.`
Parameters	`osid.relationship.rules.RelationshipEnablerForm`	`relationshipEnablerForm`	the form for this `RelationshipEnabler`
Return	`osid.relationship.rules.RelationshipEnabler`		the new `RelationshipEnabler`
Errors	ILLEGAL_STATE		`relationshipEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`relationshipEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`relationshipEnablerForm` did not originate from `getRelationshipEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRelationshipEnablers
Description	Tests if this user can update relationship enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `RelationshipEnabler` 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 `RelationshipEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablerFormForUpdate
Description	Gets the relationship enabler form for updating an existing relationship enabler. A new relationship enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`relationshipEnablerId`	the `Id` of the `RelationshipEnabler`
Return	`osid.relationship.rules.RelationshipEnablerForm`		the relationship enabler form
Errors	NOT_FOUND		`relationshipEnablerId` is not found
	NULL_ARGUMENT		`relationshipEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRelationshipEnabler
Description	Updates an existing relationship enabler.
Parameters	`osid.relationship.rules.RelationshipEnablerForm`	`relationshipEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`relationshipEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`relationshipEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`relationshipEnablerForm` did not originate from `getRelationshipEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRelationshipEnablers
Description	Tests if this user can delete relationship enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `RelationshipEnabler` 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 `RelationshipEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRelationshipEnabler
Description	Deletes a `RelationshipEnabler.`
Parameters	`osid.id.Id`	`relationshipEnablerId`	the `Id` of the `RelationshipEnabler` to remove
Errors	NOT_FOUND		`relationshipEnablerId` not found
	NULL_ARGUMENT		`relationshipEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRelationshipEnablerAliases
Description	Tests if this user can manage `Id` aliases for relationship enablers. 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 `RelationshipEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRelationshipEnabler
Description	Adds an `Id` to a `RelationshipEnabler` for the purpose of creating compatibility. The primary `Id` of the `RelationshipEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another relationship enabler. it is reassigned to the given relationship enabler `Id.`
Parameters	`osid.id.Id`	`relationshipEnablerId`	the `Id` of a `RelationshipEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`relationshipEnablerId` not found
	NULL_ARGUMENT		`relationshipEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.