OSID - osid.repository.CompositionAdminSession Service Interface Definition

Interface	osid.repository.CompositionAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Compositions.` 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 `Composition,` a `CompositionForm` is requested using `getCompositionFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `CompositionForm` 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 `CompositionForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CompositionForm` corresponds to an attempted transaction. For updates, `CompositionForms` are requested to the `Composition` `Id` that is to be updated using `getCompositionFormForUpdate().` Similarly, the `CompositionForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CompositionForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Compositions.` To unmap a `Composition` from the current `Repository,` the `CompositionRepositoryAssignmentSession` should be used. These delete operations attempt to remove the `Bid` itself thus removing it from all known `Repository` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCompositions
Description	Tests if this user can create `Compositions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Composition` 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 `Composition` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCompositionWithRecordTypes
Description	Tests if this user can create a single `Composition` using the desired record types. While `RepositoryManager.getCompositionRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Composition.` Providing an empty array tests if a `Composition` can be created with no records.
Parameters	`osid.type.Type[]`	`compositionRecordTypes`	array of composition record types
Return	`boolean`		`true` if `Composition` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`compositionRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionFormForCreate
Description	Gets the composition form for creating new compositions. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`compositionRecordTypes`	array of composition record types
Return	`osid.repository.CompositionForm`		the composition form
Errors	NULL_ARGUMENT		`compositionRecordTypes` 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	createComposition
Description	Creates a new `Composition.`
Parameters	`osid.repository.CompositionForm`	`composiitonForm`	the form for this `Composition`
Return	`osid.repository.Composition`		the new `Composition`
Errors	ILLEGAL_STATE		`compositionForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`compositionForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`compositionForm` did not originate from `getCompositionFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCompositions
Description	Tests if this user can update `Compositions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Composition` 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 `Composition` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCompositionFormForUpdate
Description	Gets the composition form for updating an existing composition. A new composition form should be requested for each update transaction.
Parameters	`osid.id.Id`	`compositionId`	the `Id` of the `Composition`
Return	`osid.repository.CompositionForm`		the composition form
Errors	NOT_FOUND		`compositionId` is not found
	NULL_ARGUMENT		`compositionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateComposition
Description	Updates an existing composition.
Parameters	`osid.repository.CompositionForm`	`composiitonForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`compositionForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`compositionForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`compositionForm` did not originate from `getCompositionFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCompositions
Description	Tests if this user can delete `Compositions.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Composition` 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 `Composition` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteComposition
Description	Deletes a `Composition.`
Parameters	`osid.id.Id`	`compositionId`	the `Id` of the `Composition` to remove
Errors	NOT_FOUND		`compositionId` not found
	NULL_ARGUMENT		`compositionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	deleteCompositionNode
Description	Deletes a `Composition` and all contained children.
Parameters	`osid.id.Id`	`compositionId`	the `Id` of the `Composition` to remove
Errors	NOT_FOUND		`compositionId` not found
	NULL_ARGUMENT		`compositionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addCompositionChild
Description	Adds a composition to a parent composition.
Parameters	`osid.id.Id`	`compositionId`	the `Id` of a parent `Composition`
Parameters	`osid.id.Id`	`childCompositionId`	the `Id` of a child `Composition`
Errors	ALREADY_EXISTS		`childCompositionId` is already a child of `compositionId`
	NOT_FOUND		`compositionId` or `childCompositionId` is not found
	NULL_ARGUMENT		`compositionId` or `childCompositionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeCompositionChild
Description	Removes a composition from a parent composition.
Parameters	`osid.id.Id`	`compositionId`	the `Id` of a parent `Composition`
Parameters	`osid.id.Id`	`childCompositionId`	the `Id` of a child `Composition`
Errors	NOT_FOUND		`compositionId` or `childCompositionId` is not found or not related
	NULL_ARGUMENT		`compositionId` or `childCompositionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCompositionAliases
Description	Tests if this user can manage `Id` aliases for `Compositions.` 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 `Composition` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasComposition
Description	Adds an `Id` to a `Composition` for the purpose of creating compatibility. The primary `Id` of the `Composition` is determined by the provider. The new `Id` is an alias to the primary `Id.` If the alias is a pointer to another composition, it is reassigned to the given composition `Id.`
Parameters	`osid.id.Id`	`compositionId`	the `Id` of a `Composition`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`compositionId` not found
	NULL_ARGUMENT		`compositionId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.