OSID - osid.learning.ObjectiveAdminSession Service Interface Definition

Interface	osid.learning.ObjectiveAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Objectives.` 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 `Objective,` a `ObjectiveForm` is requested using `getObjectiveFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ObjectiveForm` 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 `ObjectiveForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ObjectiveForm` corresponds to an attempted transaction. For updates, `ObjectiveForms` are requested to the `Objective` `Id` that is to be updated using `getObjectiveFormForUpdate().` Similarly, the `ObjectiveForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ObjectiveForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Objectives.` To unmap an `Objective` from the current `ObjectiveBank,` the `ObjectiveObjectiveBankAssignmentSession` should be used. These delete operations attempt to remove the `Objective` itself thus removing it from all known `ObjectiveBank` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getObjectiveBankId
Description	Gets the `ObjectiveBank` `Id` associated with this session.
Return	`osid.id.Id`		the `ObjectiveBank Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveBank
Description	Gets the `ObjectiveBank` associated with this session.
Return	`osid.learning.ObjectiveBank`		the `ObjectiveBank` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateObjectives
Description	Tests if this user can create `Objectives.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an Objective 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 `Objective` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateObjectiveWithRecordTypes
Description	Tests if this user can create a single `Objective` using the desired record types. While `LearningManager.getObjectiveRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Objective.` Providing an empty array tests if an `Objective` can be created with no records.
Parameters	`osid.type.Type[]`	`objectiveRecordTypes`	array of objective record types
Return	`boolean`		`true` if `Objective` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`objectiveRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveFormForCreate
Description	Gets the objective form for creating new objectives. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`objectiveRecordTypes`	array of objective record types
Return	`osid.learning.ObjectiveForm`		the objective form
Errors	NULL_ARGUMENT		`objectiveRecordTypes` 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	createObjective
Description	Creates a new `Objective.`
Parameters	`osid.learning.ObjectiveForm`	`objectiveForm`	the form for this `Objective`
Return	`osid.learning.Objective`		the new `Objective`
Errors	ILLEGAL_STATE		`objectiveForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`objectiveForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`objectiveForm` did not originate from `getObjectiveFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateObjectives
Description	Tests if this user can update `Objectives.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Objective` 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 objective modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveFormForUpdate
Description	Gets the objective form for updating an existing objective. A new objective form should be requested for each update transaction.
Parameters	`osid.id.Id`	`objectiveId`	the `Id` of the `Objective`
Return	`osid.learning.ObjectiveForm`		the objective form
Errors	NOT_FOUND		`objectiveId` is not found
	NULL_ARGUMENT		`objectiveId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateObjective
Description	Updates an existing objective.
Parameters	`osid.learning.ObjectiveForm`	`objectiveForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`objectiveForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`objectiveForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`objectiveForm` did not originate from `getObjectiveFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteObjectives
Description	Tests if this user can delete `Objectives.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Objective` 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 `Objective` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteObjective
Description	Deletes the `Objective` identified by the given `Id.`
Parameters	`osid.id.Id`	`objectiveId`	the `Id` of the `Objective` to delete
Errors	NOT_FOUND		an `Objective` was not found identified by the given `Id`
	NULL_ARGUMENT		`objectiveId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageObjectiveAliases
Description	Tests if this user can manage `Id` aliases for `Objectives.` 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 `Objective` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasObjective
Description	Adds an `Id` to an `Objective` for the purpose of creating compatibility. The primary `Id` of the `Objective` 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, it is reassigned to the given objective `Id.`
Parameters	`osid.id.Id`	`objectiveId`	the `Id` of an `Objective`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`objectiveId` not found
	NULL_ARGUMENT		`objectiveId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.