Interface | osid.resourcing.rules.JobConstrainerFoundrySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupJobConstrainerFoundryMappings | ||
Description |
Tests if this user can perform lookups of job
constrainer/foundry 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 | useComparativeJobConstrainerFoundryView | ||
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 | usePlenaryJobConstrainerFoundryView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getJobConstrainerIdsByFoundry | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | foundryId | Id of the Foundry |
Return | osid.id.IdList | list of related job constrainer Ids | |
Errors | NOT_FOUND | foundryId is not found | |
NULL_ARGUMENT | foundryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJobConstrainersByFoundry | ||
Description |
Gets the list of job constrainer associated with a
| ||
Parameters | osid.id.Id | foundryId | Id of the Foundry |
Return | osid.resourcing.rules.JobConstrainerList | list of related job constrainers | |
Errors | NOT_FOUND | foundryId is not found | |
NULL_ARGUMENT | foundryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJobConstrainerIdsByFoundries | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | foundryIds | list of foundry Ids |
Return | osid.id.IdList | list of job constrainer Ids | |
Errors | NULL_ARGUMENT | foundryIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJobConstrainersByFoundries | ||
Description |
Gets the list of job constrainer corresponding to a
list of | ||
Parameters | osid.id.IdList | foundryIds | list of foundry Ids |
Return | osid.resourcing.rules.JobConstrainerList | list of job constrainers | |
Errors | NULL_ARGUMENT | foundryIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFoundryIdsByJobConstrainer | ||
Description |
Gets the | ||
Parameters | osid.id.Id | jobConstrainerId | Id of a JobConstrainer |
Return | osid.id.IdList | list of foundries | |
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 | getFoundrysByJobConstrainer | ||
Description |
Gets the | ||
Parameters | osid.id.Id | jobConstrainerId | Id of a JobConstrainer |
Return | osid.resourcing.FoundryList | list of foundries | |
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. |