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

Interface	osid.resourcing.rules.JobConstrainerEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.resourcing.rules.ResourcingRulesManager`
Used By	`osid.resourcing.rules.ResourcingRulesProxyManager`
Description	This session creates and removes job constrainer enablers. The data for create and update is provided via the `JobConstrainerEnablerForm`.
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	canCreateJobConstrainerEnabler
Description	Tests if this user can create job constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known a `JobConstrainerEnabler` 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 `JobConstrainerEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateJobConstrainerEnablerWithRecordTypes
Description	Tests if this user can create a single `JobConstrainerEnabler` using the desired record types. While `ResourcingRulesManager.getJobConstrainerEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `JobConstrainerEnabler`. Providing an empty array tests if a `JobConstrainerEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`jobConstrainerEnablerRecordTypes`	array of job constrainer enabler record types
Return	`boolean`		`true` if `JobConstrainerEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`jobConstrainerEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getJobConstrainerEnablerFormForCreate
Description	Gets the job constrainer enabler form for creating new job constrainer enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`jobConstrainerEnablerRecordTypes`	array of job constrainer enabler record types
Return	`osid.resourcing.rules.JobConstrainerEnablerForm`		the job constrainer enabler form
Errors	NULL_ARGUMENT		`jobConstrainerEnablerRecordTypes` 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	createJobConstrainerEnabler
Description	Creates a new `JobConstrainerEnabler`.
Parameters	`osid.resourcing.rules.JobConstrainerEnablerForm`	`jobConstrainerEnablerForm`	the form for this `JobConstrainerEnabler`
Return	`osid.resourcing.rules.JobConstrainerEnabler`		the new `JobConstrainerEnabler`
Errors	ILLEGAL_STATE		`jobConstrainerEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`jobConstrainerEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`jobConstrainerEnablerForm` did not originate from `getJobConstrainerEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateJobConstrainerEnablers
Description	Tests if this user can update job constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `JobConstrainerEnabler` 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 `JobConstrainerEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getJobConstrainerEnablerFormForUpdate
Description	Gets the job constrainer enabler form for updating an existing job constrainer enabler. A new job constrainer enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`jobConstrainerEnablerId`	the `Id` of the `JobConstrainerEnabler`
Return	`osid.resourcing.rules.JobConstrainerEnablerForm`		the job constrainer enabler form
Errors	NOT_FOUND		`jobConstrainerEnablerId` is not found
	NULL_ARGUMENT		`jobConstrainerEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateJobConstrainerEnabler
Description	Updates an existing job constrainer enabler.
Parameters	`osid.resourcing.rules.JobConstrainerEnablerForm`	`jobConstrainerEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`jobConstrainerEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`jobConstrainerEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`jobConstrainerEnablerForm` did not originate from `getJobConstrainerEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteJobConstrainerEnablers
Description	Tests if this user can delete job constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `JobConstrainerEnabler` 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 `JobConstrainerEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteJobConstrainerEnabler
Description	Deletes a `JobConstrainerEnabler`.
Parameters	`osid.id.Id`	`jobConstrainerEnablerId`	the `Id` of the `JobConstrainerEnabler` to remove
Errors	NOT_FOUND		`jobConstrainerEnablerId` not found
	NULL_ARGUMENT		`jobConstrainerEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageJobConstrainerEnablerAliases
Description	Tests if this user can manage `Id` aliases for job constrainer 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 `JobConstrainerEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasJobConstrainerEnabler
Description	Adds an `Id` to a `JobConstrainerEnabler` for the purpose of creating compatibility. The primary `Id` of the `JobConstrainerEnabler` 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 constrainer enabler. it is reassigned to the given job constrainer enabler `Id`.
Parameters	`osid.id.Id`	`jobConstrainerEnablerId`	the `Id` of a `JobConstrainerEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`jobConstrainerEnablerId` not found
	NULL_ARGUMENT		`jobConstrainerEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.