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

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