Interface | osid.resourcing.JobLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. The methods | ||
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 | canLookupJobs | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeJobView | ||
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 | usePlenaryJobView | ||
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 jobs 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 | useActiveJobView | ||
Description |
Only active jobs are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusJobView | ||
Description |
All active and inactive authorization enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getJob | ||
Description |
Gets the In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned. | ||
Parameters | osid.id.Id | jobId | Id of the Job |
Return | osid.resourcing.Job | the job | |
Errors | NOT_FOUND | jobId not found | |
NULL_ARGUMENT | jobId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getJobsByIds | ||
Description |
Gets a In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned. | ||
Parameters | osid.id.IdList | jobIds | the list of Ids to retrieve |
Return | osid.resourcing.JobList | the returned Job list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | jobIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJobsByGenusType | ||
Description |
Gets a In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned. | ||
Parameters | osid.type.Type | jobGenusType | a job genus type |
Return | osid.resourcing.JobList | the returned Job list | |
Errors | NULL_ARGUMENT | jobGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJobsByParentGenusType | ||
Description |
Gets a In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned. | ||
Parameters | osid.type.Type | jobGenusType | a job genus type |
Return | osid.resourcing.JobList | the returned Job list | |
Errors | NULL_ARGUMENT | jobGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJobsByRecordType | ||
Description |
Gets a In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned. | ||
Parameters | osid.type.Type | jobRecordType | a job record type |
Return | osid.resourcing.JobList | the returned Job list | |
Errors | NULL_ARGUMENT | jobRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJobsByProvider | ||
Description |
Gets a In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.resourcing.JobList | the returned Job list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJobs | ||
Description |
Gets all In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned. | ||
Return | osid.resourcing.JobList | a list of Jobs | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |