Interface | osid.resourcing.rules.JobProcessorRuleApplicationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to apply | ||
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 | canAssignJobProcessors | ||
Description |
Tests if this user can alter job processor/job
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | assignJobProcessorToJob | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | jobProcessorId | the Id of the JobProcessor |
osid.id.Id | jobId | the Id of the Job | |
Errors | ALREADY_EXISTS | jobProcessorId is already applied to jobId | |
NOT_FOUND | jobProcessorId or jobId not found | ||
NULL_ARGUMENT | jobProcessorId or jobId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignJobProcessorFromJob | ||
Description |
Removes a | ||
Parameters | osid.id.Id | jobProcessorId | the Id of the JobProcessor |
osid.id.Id | jobId | the Id of the Job | |
Errors | NOT_FOUND | jobProcessorId or jobId not found or
jobProcessorId not applied to jobId | |
NULL_ARGUMENT | jobProcessorId or jobId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceJobProcessors | ||
Description |
Tests if this user can order | ||
Return | boolean | false if JobProcessor ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveJobProcessorAhead | ||
Description |
Reorders job processors for a job by moving the specified job enabler in front of a reference job processor. | ||
Parameters | osid.id.Id | jobProcessorId | the Id of a JobProcessor |
osid.id.Id | jobId | the Id of a Job | |
osid.id.Id | referenceId | the reference job processor Id | |
Errors | NOT_FOUND | jobProcessorId, jobId, or referenceId not
found or, jobProcessorId or referenceId not
related to jobId | |
NULL_ARGUMENT | jobProcessorId, jobId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveJobProcessorBehind | ||
Description |
Reorders job processors for a job by moving the specified job enabler behind a reference job processor. | ||
Parameters | osid.id.Id | jobProcessorId | the Id of a JobProcessor |
osid.id.Id | jobId | the Id of a Job | |
osid.id.Id | referenceId | the reference job processor Id | |
Errors | NOT_FOUND | jobProcessorId, jobId, or referenceId not
found or, jobProcessorId or referenceId not
related to jobId | |
NULL_ARGUMENT | jobProcessorId, jobId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderJobProcessors | ||
Description |
Reorders a set of job processors for a job. | ||
Parameters | osid.id.Id[] | jobProcessorIds | the Ids for a set of JobProcessor |
osid.id.Id | jobId | the Id of a Job | |
Errors | NOT_FOUND | jobId not found or, a jobProcessorId not
related to jobId | |
NULL_ARGUMENT | jobProcessorIds or jobId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |