OSID - osid.resourcing.JobAdminSession Service Interface Definition

Interface	osid.resourcing.JobAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Jobs.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Job,` a `JobForm` is requested using `getJobFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `JobForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `JobForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `JobForm` corresponds to an attempted transaction. For updates, `JobForms` are requested to the `Job` `Id` that is to be updated using `getWJobFormForUpdate().` Similarly, the `JobForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `JobForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Jobs.` To unmap a `Job` from the current `Foundry,` the `JobFormAssignmentSession` should be used. These delete operations attempt to remove the `Job` itself thus removing it from all known `Foundry` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
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	canCreateJobs
Description	Tests if this user can create `Jobs.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Job` 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 `Job` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateJobWithRecordTypes
Description	Tests if this user can create a single `Job` using the desired record types. While `ResourcingManager.getJobRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Job.` Providing an empty array tests if a `Job` can be created with no records.
Parameters	`osid.type.Type[]`	`jobRecordTypes`	array of job record types
Return	`boolean`		`true` if `Job` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`jobRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getJobFormForCreate
Description	Gets the job form for creating new jobs. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`jobRecordTypes`	array of job record types
Return	`osid.resourcing.JobForm`		the job form
Errors	NULL_ARGUMENT		`jobRecordTypes` 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	createJob
Description	Creates a new `Job.`
Parameters	`osid.resourcing.JobForm`	`jobForm`	the form for this `Job`
Return	`osid.resourcing.Job`		the new `Job`
Errors	ILLEGAL_STATE		`jobForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`jobForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`jobForm` did not orginiate from `getJobFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateJobs
Description	Tests if this user can update `Jobs.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Job` 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 `Job` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getJobFormForUpdate
Description	Gets the job form for updating an existing job. A new job form should be requested for each update transaction.
Parameters	`osid.id.Id`	`jobId`	the `Id` of the `Job`
Return	`osid.resourcing.JobForm`		the job form
Errors	NOT_FOUND		`jobId` is not found
	NULL_ARGUMENT		`jobId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateJob
Description	Updates an existing job.
Parameters	`osid.resourcing.JobForm`	`jobForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`jobForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`jobId` or `jobForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`jobForm` did not orginiate from `getJobFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteJobs
Description	Tests if this user can delete `Jobs.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Job` 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 `Job` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteJob
Description	Deletes a `Job.`
Parameters	`osid.id.Id`	`jobId`	the `Id` of the `Job` to remove
Errors	NOT_FOUND		`jobId` not found
	NULL_ARGUMENT		`jobId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageJobAliases
Description	Tests if this user can manage `Id` aliases for `Jobs.` 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 `Job` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasJob
Description	Adds an `Id` to a `Job` for the purpose of creating compatibility. The primary `Id` of the `Job` 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, it is reassigned to the given job `Id.`
Parameters	`osid.id.Id`	`jobId`	the `Id` of a `Job`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`jobId` not found
	NULL_ARGUMENT		`jobId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.