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

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

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

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

Gets a job processor enabler query.

Returnosid.resourcing.rules.JobProcessorEnablerQuerythe job processor enabler query
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorEnablerSearchOrder
Description

Gets a job processor enabler search order.

Returnosid.resourcing.rules.JobProcessorEnablerSearchOrderthe job processor enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyJobProcessorEnablerQuery
Description

Applies a job processor enabler query to this foundry.

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

Gets a job processor enabler query inspector for this foundry.

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

Applies a job processor enabler search order to this foundry.

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

Gets a job processor enabler query from an inspector.

Parametersosid.resourcing.rules.JobProcessorEnablerQueryInspectorjobProcessorEnablerQueryInspectora job processor enabler query inspector
Returnosid.resourcing.rules.JobProcessorEnablerQuerythe job processor enabler query
ErrorsNULL_ARGUMENT jobProcessorEnablerQueryInspector is null
UNSUPPORTED jobProcessorEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.