OSID - osid.assessment.authoring.SequenceRuleAdminSession Service Interface Definition

Interface	osid.assessment.authoring.SequenceRuleAdminSession
Implements	`osid.OsidSession`
Description	This session creates and removes sequence rules. The data for create and update is provided via the `SequenceRuleForm.`
Method	getBankId
Description	Gets the `Bank` `Id` associated with this session.
Return	`osid.id.Id`		the `Bank Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBank
Description	Gets the `Bank` associated with this session.
Return	`osid.assessment.Bank`		the bank
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateSequenceRule
Description	Tests if this user can create sequence rules. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `SequenceRule` 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 `SequenceRule` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateSequenceRuleWithRecordTypes
Description	Tests if this user can create a single `SequenceRule` using the desired record types. While `AssessmentAuthoringManager.getSequenceRuleRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `SequenceRule.` Providing an empty array tests if a `SequenceRule` can be created with no records.
Parameters	`osid.type.Type[]`	`sequenceRuleRecordTypes`	array of sequence rule record types
Return	`boolean`		`true` if `SequenceRule` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`sequenceRuleRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRuleFormForCreate
Description	Gets the sequence rule form for creating new sequence rules between two assessment parts. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`assessmentPartId`	the source assessment part `Id`
	`osid.id.Id`	`nextAssessmentPartId`	the target assessment part `Id`
	`osid.type.Type[]`	`sequenceRuleRecordTypes`	array of sequence rule record types
Return	`osid.assessment.authoring.SequenceRuleForm`		the sequence rule form
Errors	INVALID_ARGUMENT		`assessmentPartId` and `nextAssessmentPartId` not on the same assessment
	NOT_FOUND		`assessmentPartId` or `nextAssessmentPartId` is not found
	NULL_ARGUMENT		`assessmentPartId, nextAssessmentPartId` , or `sequenceRuleRecordTypes` 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	createSequenceRule
Description	Creates a new `SequenceRule.`
Parameters	`osid.assessment.authoring.SequenceRuleForm`	`sequenceRuleForm`	the form for this `SequenceRule`
Return	`osid.assessment.authoring.SequenceRule`		the new `SequenceRule`
Errors	ILLEGAL_STATE		`sequenceRuleForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`sequenceRuleForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`sequenceRuleForm` did not originate from `getSequenceRuleFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateSequenceRules
Description	Tests if this user can update sequence rules. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `SequenceRule` 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 `SequenceRule` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRuleFormForUpdate
Description	Gets the sequence rule form for updating an existing sequence rule. A new sequence rule form should be requested for each update transaction.
Parameters	`osid.id.Id`	`sequenceRuleId`	the `Id` of the `SequenceRule`
Return	`osid.assessment.authoring.SequenceRuleForm`		the sequence rule form
Errors	NOT_FOUND		`sequenceRuleId` is not found
	NULL_ARGUMENT		`sequenceRuleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateSequenceRule
Description	Updates an existing sequence rule.
Parameters	`osid.assessment.authoring.SequenceRuleForm`	`sequenceRuleForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`sequenceRuleForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`sequenceRuleForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`sequenceRuleForm` did not originate from `getSequenceRuleFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteSequenceRules
Description	Tests if this user can delete sequence rules. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `SequenceRule` 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 `SequenceRule` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteSequenceRule
Description	Deletes a `SequenceRule.`
Parameters	`osid.id.Id`	`sequenceRuleId`	the `Id` of the `SequenceRule` to remove
Errors	NOT_FOUND		`sequenceRuleId` not found
	NULL_ARGUMENT		`sequenceRuleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSequenceRuleAliases
Description	Tests if this user can manage `Id` aliases for sequence rules. 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 `SequenceRule` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasSequenceRule
Description	Adds a `Id` to a `SequenceRule` for the purpose of creating compatibility. The primary `Id` of the `SequenceRule` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another sequence rule. it is reassigned to the given sequence rule `Id.`
Parameters	`osid.id.Id`	`sequenceRuleId`	the `Id` of a `SequenceRule`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`sequenceRuleId` not found
	NULL_ARGUMENT		`sequenceRuleId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceSequenceRules
Description	Tests if this user can order `SequenceRules.` A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `SequenceRule` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveSequenceRuleAhead
Description	Reorders sequence rule for a source assessment part by moving the specified sequence rule in front of a reference sequence rule.
Parameters	`osid.id.Id`	`sequenceRuleId`	the `Id` of a `SequenceRule`
	`osid.id.Id`	`assessmentPartId`	the `Id` of an `AssessmentPart`
	`osid.id.Id`	`referenceId`	the reference sequence rule `Id`
Errors	NOT_FOUND		`sequenceRuleId, assessmentPartId,` or `referenceId` not found or, `sequenceRuleId` or `referenceId` not related to `assessmentPartId`
	NULL_ARGUMENT		`sequenceRuleId, assessmentPartId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveSequenceRuleBehind
Description	Reorders sequence rule for a source assessment part by moving the specified sequence rule behind a reference sequence rule.
Parameters	`osid.id.Id`	`sequenceRuleId`	the `Id` of a `SequenceRule`
	`osid.id.Id`	`assessmentPartId`	the `Id` of an `AssessmentPart`
	`osid.id.Id`	`referenceId`	the reference sequence rule `Id`
Errors	NOT_FOUND		`sequenceRuleId, assessmentPartId,` or `referenceId` not found or, `sequenceRuleId` or `referenceId` not related to `assessmentPartId`
	NULL_ARGUMENT		`sequenceRuleId, assessmentPartId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderSequenceRules
Description	Reorders a set of sequence rules for an assessment part.
Parameters	`osid.id.Id[]`	`sequenceRuleIds`	the `Ids` for a set of `SequenceRules`
Parameters	`osid.id.Id`	`assessmentPartId`	the `Id` of an `AssessmentPart`
Errors	NOT_FOUND		`assessmentPartId` not found or, a `sequenceRuleId` not related to `assessmentPartId`
	NULL_ARGUMENT		`sequenceRuleIds` or `assessmentPartId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.