OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.JobQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching among Job objects. The search query is constructed using the JobQuery.

This session defines views that offer differing behaviors for searching.

  • federated foundry view: searches include jobs in foundries of which this foundry is an ancestor in the foundry hierarchy
  • isolated foundry view: searches are restricted to jobs in this foundry

Jobs may have a query record indicated by their respective record types. The query record is accessed via the JobQuery.

MethodgetFoundryId
Description

Gets the Foundry Id associated with this session.

Returnosid.id.Idthe Foundry Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFoundry
Description

Gets the Foundry associated with this session.

Returnosid.resourcing.Foundrythe foundry
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchJobs
Description

Tests if this user can perform Job lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedFoundryView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedFoundryView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this foundry only.

CompliancemandatoryThis method is must be implemented.
MethodgetJobQuery
Description

Gets a job query.

Returnosid.resourcing.JobQuerythe job query
CompliancemandatoryThis method must be implemented.
MethodgetJobsByQuery
Description

Gets a list of Jobs matching the given job query.

Parametersosid.resourcing.JobQueryjobQuerythe job query
Returnosid.resourcing.JobListthe returned JobList
ErrorsNULL_ARGUMENT jobQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED jobQuery is not of this service
CompliancemandatoryThis method must be implemented.