Interface | osid.resourcing.rules.JobProcessorAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes job processors. The data
for create and update is provided via the | ||
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 | canCreateJobProcessor | ||
Description |
Tests if this user can create job processors. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known creating a
| ||
Return | boolean | false if JobProcessor creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateJobProcessorWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | jobProcessorRecordTypes | array of job processor record types |
Return | boolean | true if JobProcessor creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | jobProcessorRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getJobProcessorFormForCreate | ||
Description |
Gets the job processor form for creating new job processors. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | jobProcessorRecordTypes | array of job processor record types |
Return | osid.resourcing.rules.JobProcessorForm | the job processor form | |
Errors | NULL_ARGUMENT | jobProcessorRecordTypes 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 | createJobProcessor | ||
Description |
Creates a new | ||
Parameters | osid.resourcing.rules.JobProcessorForm | jobProcessorForm | the form for this JobProcessor |
Return | osid.resourcing.rules.JobProcessor | the new JobProcessor | |
Errors | ILLEGAL_STATE | jobProcessorForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | jobProcessorForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | jobProcessorForm did not originate from
getJobProcessorFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateJobProcessors | ||
Description |
Tests if this user can update job processors. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known updating a
| ||
Return | boolean | false if JobProcessor modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getJobProcessorFormForUpdate | ||
Description |
Gets the job processor form for updating an existing job processor. A new job processor form should be requested for each update transaction. | ||
Parameters | osid.id.Id | jobProcessorId | the Id of the JobProcessor |
Return | osid.resourcing.rules.JobProcessorForm | the job processor form | |
Errors | NOT_FOUND | jobProcessorId is not found | |
NULL_ARGUMENT | jobProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateJobProcessor | ||
Description |
Updates an existing job processor. | ||
Parameters | osid.resourcing.rules.JobProcessorForm | jobProcessorForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | jobProcessorForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | jobProcessorForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | jobProcessorForm did not originate from
getJobProcessorFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteJobProcessors | ||
Description |
Tests if this user can delete job processors. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known deleting a
| ||
Return | boolean | false if JobProcessor deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteJobProcessor | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | jobProcessorId | the Id of the JobProcessor to remove |
Errors | NOT_FOUND | jobProcessorId not found | |
NULL_ARGUMENT | jobProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageJobProcessorAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if JobProcessor aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasJobProcessor | ||
Description |
Adds an | ||
Parameters | osid.id.Id | jobProcessorId | the Id of a JobProcessor |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | jobProcessorId not found | ||
NULL_ARGUMENT | jobProcessorId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |