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

This session manages queries and sequencing to create "smart" dynamic catalogs. A JobQuery can be retrieved from this session and mapped to this Foundry to create a virtual collection of Jobs. The jobs may be sequenced using the JobSearchOrder from this session.

This Foundry has a default query that matches any job and a default search order that specifies no sequencing. The queries may be examined using a JobQueryInspector. The query may be modified by converting the inspector back to a 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.
MethodcanManageSmartFoundries
Description

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

Returnboolean false if smart foundry management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetJobQuery
Description

Gets a job query.

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

Gets a job search order.

Returnosid.resourcing.JobSearchOrderthe job search order
CompliancemandatoryThis method must be implemented.
MethodapplyJobQuery
Description

Applies a job query to this foundry.

Parametersosid.resourcing.JobQueryjobQuerythe job query
ErrorsNULL_ARGUMENT jobQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED jobQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectJobQuery
Description

Gets a job query inspector for this foundry.

Returnosid.resourcing.JobQueryInspectorthe job query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyJobSequencing
Description

Applies a job search order to this foundry.

Parametersosid.resourcing.JobSearchOrderjobSearchOrderthe job search order
ErrorsNULL_ARGUMENT jobSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED jobSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetJobQueryFromInspector
Description

Gets a job query from an inspector.

Parametersosid.resourcing.JobQueryInspectorjobQueryInspectora job query inspector
Returnosid.resourcing.JobQuerythe job query
ErrorsNULL_ARGUMENT jobQueryInspector is null
UNSUPPORTED jobQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.