OSID - osid.resourcing.rules.JobProcessorEnablerAdminSession Service Interface Definition

Interface	osid.resourcing.rules.JobProcessorEnablerAdminSession
Implements	`osid.OsidSession`
Description	This session creates and removes job processor enablers. The data for create and update is provided via the `JobProcessorEnablerForm.`
Method	getFoundryId
Description	Gets the `Foundry` `Id` associated with this session.
Return	`osid.id.Id`		the `Foundry Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFoundry
Description	Gets the `Foundry` associated with this session.
Return	`osid.resourcing.Foundry`		the foundry
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateJobProcessorEnabler
Description	Tests if this user can create job processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `JobProcessorEnabler` 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 `JobProcessorEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateJobProcessorEnablerWithRecordTypes
Description	Tests if this user can create a single `JobProcessorEnabler` using the desired record types. While `ResourcingRulesManager.getJobProcessorEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `JobProcessorEnabler.` Providing an empty array tests if a `JobProcessorEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`jobProcessorEnablerRecordTypes`	array of job processor enabler record types
Return	`boolean`		`true` if `JobProcessorEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`jobProcessorEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorEnablerFormForCreate
Description	Gets the job processor enabler form for creating new job processor enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`jobProcessorEnablerRecordTypes`	array of job processor enabler record types
Return	`osid.resourcing.rules.JobProcessorEnablerForm`		the job processor enabler form
Errors	NULL_ARGUMENT		`jobProcessorEnablerRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form with requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createJobProcessorEnabler
Description	Creates a new `JobProcessorEnabler.`
Parameters	`osid.resourcing.rules.JobProcessorEnablerForm`	`jobProcessorEnablerForm`	the form for this `JobProcessorEnabler`
Return	`osid.resourcing.rules.JobProcessorEnabler`		the new `JobProcessorEnabler`
Errors	ILLEGAL_STATE		`jobProcessorEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`jobProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`jobProcessorEnablerForm` did not originate from `getJobProcessorEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateJobProcessorEnablers
Description	Tests if this user can update job processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `JobProcessorEnabler` 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 `JobProcessorEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getJobProcessorEnablerFormForUpdate
Description	Gets the job processor enabler form for updating an existing job processor enabler. A new job processor enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`jobProcessorEnablerId`	the `Id` of the `JobProcessorEnabler`
Return	`osid.resourcing.rules.JobProcessorEnablerForm`		the job processor enabler form
Errors	NOT_FOUND		`jobProcessorEnablerId` is not found
	NULL_ARGUMENT		`jobProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateJobProcessorEnabler
Description	Updates an existing job processor enabler.
Parameters	`osid.resourcing.rules.JobProcessorEnablerForm`	`jobProcessorEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`jobProcessorEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`jobProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`jobProcessorEnablerForm` did not originate from `getJobProcessorEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteJobProcessorEnablers
Description	Tests if this user can delete job processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `JobProcessorEnabler` 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 `JobProcessorEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteJobProcessorEnabler
Description	Deletes a `JobProcessorEnabler.`
Parameters	`osid.id.Id`	`jobProcessorEnablerId`	the `Id` of the `JobProcessorEnabler` to remove
Errors	NOT_FOUND		`jobProcessorEnablerId` not found
	NULL_ARGUMENT		`jobProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageJobProcessorEnablerAliases
Description	Tests if this user can manage `Id` aliases for job processor 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 `JobProcessorEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasJobProcessorEnabler
Description	Adds an `Id` to a `JobProcessorEnabler` for the purpose of creating compatibility. The primary `Id` of the `JobProcessorEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another job processor enabler. it is reassigned to the given job processor enabler `Id.`
Parameters	`osid.id.Id`	`jobProcessorEnablerId`	the `Id` of a `JobProcessorEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`jobProcessorEnablerId` not found
	NULL_ARGUMENT		`jobProcessorEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.