| Interface | osid.resourcing.rules.JobProcessorEnablerRuleApplicationSession | ||
|---|---|---|---|
| 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 | canAssignJobProcessorEnablers | ||
| Description |
Tests if this user can alter job processor enabler/job
processor 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 | assignJobProcessorEnablerToJobProcessor | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | jobProcessorEnablerId | the Id of the JobProcessorEnabler |
osid.id.Id | jobProcessorId | the Id of the JobProcessor | |
| Errors | ALREADY_EXISTS | jobProcessorEnablerId is already applied to
jobProcessorId | |
| NOT_FOUND | jobProcessorEnablerId or jobProcessorId not
found | ||
| NULL_ARGUMENT | jobProcessorEnablerId or jobProcessorId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignJobProcessorEnablerFromJobProcessor | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | jobProcessorEnablerId | the Id of the JobProcessorEnabler |
osid.id.Id | jobProcessorId | the Id of the JobProcessor | |
| Errors | NOT_FOUND | jobProcessorEnablerId or jobProcessorId not
found or jobProcessorEnablerId not applied to
jobProcessorId | |
| NULL_ARGUMENT | jobProcessorEnablerId or jobProcessorId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceJobProcessorEnablers | ||
| Description |
Tests if this user can order | ||
| Return | boolean | false if JobProcessornEnabler ordering is not
authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveJobProcessorEnablerAhead | ||
| Description |
Reorders job processor enablers for a job processor by moving the specified job processor enabler in front of a reference job processor enabler. | ||
| Parameters | osid.id.Id | jobProcessorEnablerId | the Id of a JobProcessorEnabler |
osid.id.Id | jobProcessorId | the Id of a JobProcessor | |
osid.id.Id | referenceId | the reference job processor enabler Id | |
| Errors | NOT_FOUND | jobProcessorEnablerId, jobProcessorId, or referenceId
not found or, jobProcessorEnablerId or
referenceId not related to jobProcessorId | |
| NULL_ARGUMENT | jobProcessorEnablerId, jobProcessorId, or referenceId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveJobProcessorEnablerBehind | ||
| Description |
Reorders job processor enablers for a job processor by moving the specified job processor enabler behind a reference job processor enabler. | ||
| Parameters | osid.id.Id | jobProcessorEnablerId | the Id of a JobProcessorEnabler |
osid.id.Id | jobProcessorId | the Id of a JobProcessor | |
osid.id.Id | referenceId | the reference job processor enabler Id | |
| Errors | NOT_FOUND | jobProcessorEnablerId, jobProcessorId, or referenceId
not found or, jobProcessorEnablerId or
referenceId not related to jobProcessorId | |
| NULL_ARGUMENT | jobProcessorEnablerId, jobProcessorId, or referenceId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderJobProcessorEnablers | ||
| Description |
Reorders a set of job processor enablers for a job processor. | ||
| Parameters | osid.id.Id[] | jobProcessorEnablerIds | the Ids for a set of JobProcessorEnablers |
osid.id.Id | jobProcessorId | the Id of a JobProcessor | |
| Errors | NOT_FOUND | jobProcessorId not found or, a jobProcessorEnablerId
not related to jobProcessorId | |
| NULL_ARGUMENT | jobProcessorEnablerIds or jobProcessorId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |