Interface | osid.resourcing.rules.JobConstrainerRuleLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
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 | canLookupJobConstrainerRules | ||
Description |
Tests if this user can perform lookups of job
constrainer/job mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeJobConstrainerRuleView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryJobConstrainerRuleView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedFoundryView | ||
Description |
Federates the view for methods in this session. A federated view will include job constrainer in foundries which are children of this foundry in the foundry hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedFoundryView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this foundry only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getJobConstrainerIdsForJob | ||
Description |
Gets the | ||
Parameters | osid.id.Id | jobId | Id of the Job |
Return | osid.id.IdList | the job constrainer Ids | |
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 | getJobConstrainersForJob | ||
Description |
Gets the | ||
Parameters | osid.id.Id | jobId | Id of the Job |
Return | osid.resourcing.rules.JobConstrainerList | the job constrainers | |
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 | getJobIdsForJobConstrainer | ||
Description |
Gets the | ||
Parameters | osid.id.Id | jobConstrainerId | Id of a JobConstrainer |
Return | osid.id.IdList | list of job Ids | |
Errors | NOT_FOUND | jobConstrainerId is not found | |
NULL_ARGUMENT | jobConstrainerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJobsForJobConstrainer | ||
Description |
Gets the | ||
Parameters | osid.id.Id | jobConstrainerId | Id of a JobConstrainer |
Return | osid.resourcing.JobList | list of jobs | |
Errors | NOT_FOUND | jobConstrainerId is not found | |
NULL_ARGUMENT | jobConstrainerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |