OSID - osid.learning.ObjectiveSequencingSession Service Interface Definition

Interface	osid.learning.ObjectiveSequencingSession
Implements	`osid.OsidSession`
Description	This session provides methods to sequence the objectives in the objective hierarchy.
Method	getObjectiveHierarchyId
Description	Gets the hierarchy `Id` associated with this session.
Return	`osid.id.Id`		the hierarchy `Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getObjectiveHierarchy
Description	Gets the hierarchy associated with this session.
Return	`osid.hierarchy.Hierarchy`		the hierarchy associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceObjectives
Description	Tests if this user can sequence objectives. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.
Return	`boolean`		`false` if sequencing objectives is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveObjectiveAhead
Description	Moves an objective ahead of a refrence objective under the given parent.
Parameters	`osid.id.Id`	`parentObjectiveId`	the `Id` of the parent objective
	`osid.id.Id`	`referenceObjectiveId`	the `Id` of the objective
	`osid.id.Id`	`objectiveId`	the `Id` of the objective to move ahead of `referenceObjectiveId`
Errors	NOT_FOUND		`parentObjectiveId, referenceObjectiveId,` or `objectiveId` not found, or `referenceObjectiveId` or `objectiveId` is not a child of `parentObjectiveId`
	NULL_ARGUMENT		`parentObjectiveId, referenceObjectiveId,` or `id` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveObjectiveBehind
Description	Moves an objective behind a refrence objective under the given parent.
Parameters	`osid.id.Id`	`parentObjectiveId`	the `Id` of the parent objective
	`osid.id.Id`	`referenceObjectiveId`	the `Id` of the objective
	`osid.id.Id`	`objectiveId`	the `Id` of the objective to move behind `referenceObjectiveId`
Errors	NOT_FOUND		`parentObjectiveId, referenceObjectiveId,` or `objectiveId` not found, or `referenceObjectiveId` or `objectiveId` is not a child of `parentObjectiveId`
	NULL_ARGUMENT		`parentObjectiveId, referenceObjectiveId,` or `id` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	sequenceObjectives
Description	Sequences a set of objectives under a parent.
Parameters	`osid.id.Id`	`parentObjectiveId`	the `Id` of the parent objective
Parameters	`osid.id.Id[]`	`objectiveIds`	the `Id` of the objectives
Errors	NOT_FOUND		`parentId` or an `objectiveId` not found, or an `objectiveId` is not a child of `parentObjectiveId`
	NULL_ARGUMENT		`parenObjectivetId` or `objectiveIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.