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

This session manages queries and sequencing to create "smart" dynamic foundries. A JobProcessorQuery can be retrieved from this session and mapped to this Foundry to create a virtual collection of job processors. The job processor may be sequenced using the JobProcessorSearchOrder from this session.

This Foundry has a default query that matches any job processor and a default search order that specifies no sequencing. The queries may be examined using a JobProcessorQueryInspector. The query may be modified by converting the inspector back to a JobProcessorQuery.

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.
MethodgetJobProcessorQuery
Description

Gets a job processor query.

Returnosid.resourcing.rules.JobProcessorQuerythe job processor query
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorSearchOrder
Description

Gets a job processor search order.

Returnosid.resourcing.rules.JobProcessorSearchOrderthe job processor search order
CompliancemandatoryThis method must be implemented.
MethodapplyJobProcessorQuery
Description

Applies a job processor query to this foundry.

Parametersosid.resourcing.rules.JobProcessorQueryjobProcessorQuerythe job processor query
ErrorsNULL_ARGUMENT jobProcessorQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED jobProcessorQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectJobProcessorQuery
Description

Gets a job processor query inspector for this foundry.

Returnosid.resourcing.rules.JobProcessorQueryInspectorthe job processor query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyJobProcessorSequencing
Description

Applies a job processor search order to this foundry.

Parametersosid.resourcing.rules.JobProcessorSearchOrderjobProcessorSearchOrderthe job processor search order
ErrorsNULL_ARGUMENT jobProcessorSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED jobProcessorSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorQueryFromInspector
Description

Gets a job processor query from an inspector.

Parametersosid.resourcing.rules.JobProcessorQueryInspectorjobProcessorQueryInspectora job processor query inspector
Returnosid.resourcing.rules.JobProcessorQuerythe job processor query
ErrorsNULL_ARGUMENT jobProcessorQueryInspector is null
UNSUPPORTED jobProcessorQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.