Interface | osid.resourcing.JobAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | getFoundryId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Foundry Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getFoundry | ||
Description |
Gets the | ||
Return | osid.resourcing.Foundry | the foundry | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateJobs | ||
Description |
Tests if this user can create | ||
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 | ||
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 | ||
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 | ||
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 | ||
Return | boolean | false if Job deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteJob | ||
Description |
Deletes a | ||
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 | ||
Return | boolean | false if Job aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasJob | ||
Description |
Adds an | ||
Parameters | osid.id.Id | jobId | the Id of a Job |
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. |