OSID - osid.repository.rules.CompositionEnablerAdminSession Service Interface Definition

Interface	osid.repository.rules.CompositionEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.repository.rules.RepositoryRulesManager`
Used By	`osid.repository.rules.RepositoryRulesProxyManager`
Description	This session creates and removes composition enablers. The data for create and update is provided via the `CompositionEnablerForm`.
Method	getRepositoryId
Description	Gets the `Repository` `Id` associated with this session.
Return	`osid.id.Id`		the `Repository Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRepository
Description	Gets the `Repository` associated with this session.
Return	`osid.repository.Repository`		the repository
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCompositionEnabler
Description	Tests if this user can create composition enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `CompositionEnabler` 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 `CompositionEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCompositionEnablerWithRecordTypes
Description	Tests if this user can create a single `CompositionEnabler` using the desired record types. While `RepositoryRulesManager.getCompositionEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `CompositionEnabler`. Providing an empty array tests if a `CompositionEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`compositionEnablerRecordTypes`	array of composition enabler types
Return	`boolean`		`true` if `CompositionEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`compositionEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionEnablerFormForCreate
Description	Gets the composition enabler form for creating new composition enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`compositionEnablerRecordTypes`	array of composition enabler types
Return	`osid.repository.rules.CompositionEnablerForm`		the composition enabler form
Errors	NULL_ARGUMENT		`compositionEnablerRecordTypes` 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	createCompositionEnabler
Description	Creates a new `CompositionEnabler`.
Parameters	`osid.repository.rules.CompositionEnablerForm`	`compositionEnablerForm`	the form for this `CompositionEnabler`
Return	`osid.repository.rules.CompositionEnabler`		the new `CompositionEnabler`
Errors	ILLEGAL_STATE		`compositionEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`compositionEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`compositionEnablerForm` did not originate from `getCompositionEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCompositionEnablers
Description	Tests if this user can update composition enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `CompositionEnabler` 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 `CompositionEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionEnablerFormForUpdate
Description	Gets the composition enabler form for updating an existing composition enabler. A new composition enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`compositionEnablerId`	the `Id` of the `CompositionEnabler`
Return	`osid.repository.rules.CompositionEnablerForm`		the composition enabler form
Errors	NOT_FOUND		`compositionEnablerId` is not found
	NULL_ARGUMENT		`compositionEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCompositionEnabler
Description	Updates an existing composition enabler.
Parameters	`osid.repository.rules.CompositionEnablerForm`	`compositionEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`compositionEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`compositionEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`compositionEnablerForm` did not originate from `getCompositionEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCompositionEnablers
Description	Tests if this user can delete composition enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `CompositionEnabler` 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 `CompositionEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCompositionEnabler
Description	Deletes a `CompositionEnabler`.
Parameters	`osid.id.Id`	`compositionEnablerId`	the `Id` of the `CompositionEnabler` to remove
Errors	NOT_FOUND		`compositionEnablerId` not found
	NULL_ARGUMENT		`compositionEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCompositionEnablerAliases
Description	Tests if this user can manage `Id` aliases for composition 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 `CompositionEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCompositionEnabler
Description	Adds an `Id` to a `CompositionEnabler` for the purpose of creating compatibility. The primary `Id` of the `CompositionEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another composition enabler. it is reassigned to the given composition enabler `Id`.
Parameters	`osid.id.Id`	`compositionEnablerId`	the `Id` of a `CompositionEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`compositionEnablerId` not found
	NULL_ARGUMENT		`compositionEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.