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

Interface	osid.assessment.authoring.SequenceRuleEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.assessment.authoring.AssessmentAuthoringManager`
Used By	`osid.assessment.authoring.AssessmentAuthoringProxyManager`
Description	This session creates and removes sequence rule enablers. The data for create and update is provided via the `SequenceRuleEnablerForm`.
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	canCreateSequenceRuleEnabler
Description	Tests if this user can create sequence rule enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `SequenceRuleEnabler` 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 `SequenceRuleEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateSequenceRuleEnablerWithRecordTypes
Description	Tests if this user can create a single `SequenceRuleEnabler` using the desired record types. While `AssessmentAuthoringManager.getSequenceRuleEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `SequenceRuleEnabler`. Providing an empty array tests if a `SequenceRuleEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`sequenceRuleEnablerRecordTypes`	array of sequence rule enabler record types
Return	`boolean`		`true` if `SequenceRuleEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`sequenceRuleEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRuleEnablerFormForCreate
Description	Gets the sequence rule enabler form for creating new sequence rule enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`sequenceRuleEnablerRecordTypes`	array of sequence rule enabler record types
Return	`osid.assessment.authoring.SequenceRuleEnablerForm`		the sequence rule enabler form
Errors	NULL_ARGUMENT		`sequenceRuleEnablerRecordTypes` 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	createSequenceRuleEnabler
Description	Creates a new `SequenceRuleEnabler`.
Parameters	`osid.assessment.authoring.SequenceRuleEnablerForm`	`sequenceRuleEnablerForm`	the form for this `SequenceRuleEnabler`
Return	`osid.assessment.authoring.SequenceRuleEnabler`		the new `SequenceRuleEnabler`
Errors	ILLEGAL_STATE		`sequenceRuleEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`sequenceRuleEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`sequenceRuleEnablerForm` did not originate from `getSequenceRuleEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateSequenceRuleEnablers
Description	Tests if this user can update sequence rule enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `SequenceRuleEnabler` 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 `SequenceRuleEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSequenceRuleEnablerFormForUpdate
Description	Gets the sequence rule enabler form for updating an existing sequence rule enabler. A new sequence rule enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`sequenceRuleEnablerId`	the `Id` of the `SequenceRuleEnabler`
Return	`osid.assessment.authoring.SequenceRuleEnablerForm`		the sequence rule enabler form
Errors	NOT_FOUND		`sequenceRuleEnablerId` is not found
	NULL_ARGUMENT		`sequenceRuleEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateSequenceRuleEnabler
Description	Updates an existing sequence rule enabler.
Parameters	`osid.assessment.authoring.SequenceRuleEnablerForm`	`sequenceRuleEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`sequenceRuleEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`sequenceRuleEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`sequenceRuleEnablerForm` did not originate from `getSequenceRuleEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteSequenceRuleEnablers
Description	Tests if this user can delete sequence rule enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `SequenceRuleEnabler` 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 `SequenceRuleEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteSequenceRuleEnabler
Description	Deletes a `SequenceRuleEnabler`.
Parameters	`osid.id.Id`	`sequenceRuleEnablerId`	the `Id` of the `SequenceRuleEnabler` to remove
Errors	NOT_FOUND		`sequenceRuleEnablerId` not found
	NULL_ARGUMENT		`sequenceRuleEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSequenceRuleEnablerAliases
Description	Tests if this user can manage `Id` aliases for sequence rule enablers. 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 `SequenceRuleEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasSequenceRuleEnabler
Description	Adds a `Id` to a `SequenceRuleEnabler` for the purpose of creating compatibility. The primary `Id` of the `SequenceRuleEnabler` 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 enabler. it is reassigned to the given sequence rule enabler `Id`.
Parameters	`osid.id.Id`	`sequenceRuleEnablerId`	the `Id` of a `SequenceRuleEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`sequenceRuleEnablerId` not found
	NULL_ARGUMENT		`sequenceRuleEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.