OSID - osid.learning.ObjectiveBankAdminSession Service Interface Definition

Interface	osid.learning.ObjectiveBankAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `ObjectiveBanks.` 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 an `ObjectiveBank,` an `ObjectiveBankForm` is requested using `getObjectiveBankFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ObjectiveBankForm` 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 `ObjectiveBankForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ObjectiveBankForm` corresponds to an attempted transaction. For updates, `ObjectiveBankForms` are requested to the `ObjectiveBank` `Id` that is to be updated using `getObjectiveBankFormForUpdate().` Similarly, the `ObjectiveBankForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ObjectiveBankForm` can only be used once for a successful update and cannot be reused. The delete operations delete `ObjectiveBanks.` It is safer to remove all mappings to the `ObjectiveBank` catalogs before deletion. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateObjectiveBanks
Description	Tests if this user can create `ObjectiveBanks.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `ObjectiveBank` 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 `ObjectiveBank` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateObjectiveBankWithRecordTypes
Description	Tests if this user can create a single `ObjectiveBank` using the desired record types. While `LearningManager.getObjectiveBankRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `ObjectiveBank.` Providing an empty array tests if an `ObjectiveBank` can be created with no records.
Parameters	`osid.type.Type[]`	`objectiveBankRecordTypes`	array of objective bank record types
Return	`boolean`		`true` if `ObjectiveBank` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`objectiveBankRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveBankFormForCreate
Description	Gets the objective bank form for creating new objective banks. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`objectiveBankRecordTypes`	array of objective bank record types
Return	`osid.learning.ObjectiveBankForm`		the objective bank form
Errors	NULL_ARGUMENT		`objectiveBankRecordTypes` 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	createObjectiveBank
Description	Creates a new `ObjectiveBank.`
Parameters	`osid.learning.ObjectiveBankForm`	`objectiveBankForm`	the form for this `ObjectiveBank`
Return	`osid.learning.ObjectiveBank`		the new `ObjectiveBank`
Errors	ILLEGAL_STATE		`objectiveBankForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`objectiveBankForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`objectiveBankForm` did not originate from `getObjectiveBankFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateObjectiveBanks
Description	Tests if this user can update `ObjectiveBanks.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `ObjectiveBank` 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 `ObjectiveBank` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveBankFormForUpdate
Description	Gets the objective bank form for updating an existing objective bank. A new objective bank form should be requested for each update transaction.
Parameters	`osid.id.Id`	`objectiveBankId`	the `Id` of the `ObjectiveBank`
Return	`osid.learning.ObjectiveBankForm`		the objective bank form
Errors	NOT_FOUND		`objectiveBankId` is not found
	NULL_ARGUMENT		`objectiveBankId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateObjectiveBank
Description	Updates an existing objective bank.
Parameters	`osid.learning.ObjectiveBankForm`	`objectiveBankForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`objectiveBankForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`objectiveBankForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`objectiveBankForm did not originate from getObjectiveBankFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteObjectiveBanks
Description	Tests if this user can delete objective banks. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `ObjectiveBank` 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 `ObjectiveBank` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteObjectiveBank
Description	Deletes an `ObjectiveBank.`
Parameters	`osid.id.Id`	`objectiveBankId`	the `Id` of the `ObjectiveBank` to remove
Errors	NOT_FOUND		`objectiveBankId` not found
	NULL_ARGUMENT		`objectiveBankId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageObjectiveBankAliases
Description	Tests if this user can manage `Id` aliases for `ObjectiveBanks.` 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 `ObjectiveBank` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasObjectiveBank
Description	Adds an `Id` to an `ObjectiveBank` for the purpose of creating compatibility. The primary `Id` of the `ObjectiveBank` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another objective bank, it is reassigned to the given objective bank `Id.`
Parameters	`osid.id.Id`	`objectiveBankId`	the `Id` of an `ObjectiveBank`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`objectiveBankId` not found
	NULL_ARGUMENT		`objectiveBankId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.