OSID - osid.sequencing.ChainAdminSession Service Interface Definition

Interface	osid.sequencing.ChainAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Chains.` 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 `Chain,` a `ChainForm` is requested using `getChainFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ChainForm` 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 `ChainForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ChainForm` corresponds to an attempted transaction. For updates, `ChainForms` are requested to the `Chain` `Id` that is to be updated using `getChainFormForUpdate().` Similarly, the `ChainForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ChainForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Chains.` To unmap a `Chain` from the current `Antimatroid,` the `ChainAntimatroidAssignmentSession` should be used. These delete operations attempt to remove the `Chain` itself thus removing it from all known `Antimatroid` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getAntimatroidId
Description	Gets the `Antimatroid` `Id` associated with this session.
Return	`osid.id.Id`		the `Antimatroid Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAntimatroid
Description	Gets the `Antimatroid` associated with this session.
Return	`osid.sequencing.Antimatroid`		the antimatroid
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateChains
Description	Tests if this user can create chains. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Chain` 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 `Chain` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateChainWithRecordTypes
Description	Tests if this user can create a single `Chain` using the desired record types. While `SequencingManager.getChainRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Chain.` Providing an empty array tests if a `Chain` can be created with no records.
Parameters	`osid.type.Type[]`	`chainRecordTypes`	array of chain record types
Return	`boolean`		`true` if `Chain` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`chainRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getChainFormForCreate
Description	Gets the chain form for creating new chains. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`chainRecordTypes`	array of chain record types
Return	`osid.sequencing.ChainForm`		the chain form
Errors	NULL_ARGUMENT		`chainRecordTypes` 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	createChain
Description	Creates a new `Chain.`
Parameters	`osid.sequencing.ChainForm`	`chainForm`	the form for this `Chain`
Return	`osid.sequencing.Chain`		the new `Chain`
Errors	ILLEGAL_STATE		`chainForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NOT_FOUND		`resourceId` or `inputId` is not found
	NULL_ARGUMENT		`chainForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`chainForm` did not originate from `getChainFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateChains
Description	Tests if this user can update chains. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Chain` 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 `Chain` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getChainFormForUpdate
Description	Gets the chain form for updating an existing chain. A new chain form should be requested for each update transaction.
Parameters	`osid.id.Id`	`chainId`	the `Id` of the `Chain`
Return	`osid.sequencing.ChainForm`		the chain form
Errors	NOT_FOUND		`chainId` is not found
	NULL_ARGUMENT		`chainId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateChain
Description	Updates an existing chain.
Parameters	`osid.sequencing.ChainForm`	`chainForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`chainForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`chainForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`chainForm` did not originate from `getChainFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteChains
Description	Tests if this user can delete chains. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Chain` 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 `Chain` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteChain
Description	Deletes a `Chain.`
Parameters	`osid.id.Id`	`chainId`	the `Id` of the `Chain` to remove
Errors	NOT_FOUND		`chainId` not found
	NULL_ARGUMENT		`chainId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageChainAliases
Description	Tests if this user can manage `Id` aliases for `Chains.` 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 `Chain` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasChain
Description	Adds an `Id` to a `Chain` for the purpose of creating compatibility. The primary `Id` of the `Chain` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another chain, it is reassigned to the given chain `Id.`
Parameters	`osid.id.Id`	`chainId`	the `Id` of a `Chain`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`chainId` not found
	NULL_ARGUMENT		`chainId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.