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

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

This session defines views that offer differing behaviors for searching.

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

Job processor enablers may have a query record indicated by their respective record types. The query record is accessed via the 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.
MethodcanSearchJobProcessorEnablers
Description

Tests if this user can perform JobProcessorEnabler 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 job processor enablers in foundries which are children of this job in the foundry hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedFoundryView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetJobProcessorEnablerQuery
Description

Gets a job processor enabler query.

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

Gets a list of JobProcessorEnablers matching the given job processor enabler query.

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