Interface | osid.resourcing.rules.JobConstrainerRuleApplicationSession | ||
---|---|---|---|
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 | canAssignJobConstrainers | ||
Description |
Tests if this user can alter job constrainer/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 | assignJobConstrainerToJob | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | jobConstrainerId | the Id of the JobConstrainer |
osid.id.Id | jobId | the Id of the Job | |
Errors | ALREADY_EXISTS | jobConstrainerId is already applied to jobId | |
NOT_FOUND | jobConstrainerId or jobId not found | ||
NULL_ARGUMENT | jobConstrainerId or jobId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignJobConstrainerFromJob | ||
Description |
Removes a | ||
Parameters | osid.id.Id | jobConstrainerId | the Id of the JobConstrainer |
osid.id.Id | jobId | the Id of the Job | |
Errors | NOT_FOUND | jobConstrainerId or jobId not found or
jobConstrainerId not applied to jobId | |
NULL_ARGUMENT | jobConstrainerId or jobId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceJobConstrainers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if JobConstrainer ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveJobConstrainerAhead | ||
Description |
Reorders job constrainers for a job constrainer by moving the specified job constrainer in front of a reference job constrainer. | ||
Parameters | osid.id.Id | jobConstrainerId | the Id of a JobConstrainer |
osid.id.Id | jobId | the Id of a Job | |
osid.id.Id | referenceId | the reference job constrainer Id | |
Errors | NOT_FOUND | jobConstrainerId, jobId, or referenceId not
found or, jobConstrainerId or referenceId not
related to jobId | |
NULL_ARGUMENT | jobConstrainerId, jobId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveJobConstrainerBehind | ||
Description |
Reorders job constrainers for a job constrainer by moving the specified job constrainer behind a reference job constrainer. | ||
Parameters | osid.id.Id | jobConstrainerId | the Id of a JobConstrainer |
osid.id.Id | jobId | the Id of a Job | |
osid.id.Id | referenceId | the reference job constrainer Id | |
Errors | NOT_FOUND | jobConstrainerId, jobId, or referenceId not
found or, jobConstrainerId or referenceId not
related to jobId | |
NULL_ARGUMENT | jobConstrainerId, jobId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderJobConstrainers | ||
Description |
Reorders a set of job constrainer for a job. | ||
Parameters | osid.id.Id[] | jobConstrainerIds | the Ids for a set of JobConstrainers |
osid.id.Id | jobId | the Id of a Job | |
Errors | NOT_FOUND | jobId not found or, a jobConstrainerId not
related to jobId | |
NULL_ARGUMENT | jobConstrainerIds or jobId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |