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

This session provides methods to retrieve JobProcessorEnabler to JobProcessor mappings. A JobProcessor with multiple JobProcessorEnablers means any positive rule evaluation across the enablers result in an effective JobProcessor.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated foundry view: All methods in this session operate, retrieve and pertain job processor enablers defined explicitly in the current foundry
  • federated foundry view: All methods in this session operate, retrieve and pertain to all job processor enablers defined in this foundry and any other job processor enablers implicitly available in this foundry through foundry inheritence.
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.
MethodcanLookupJobProcessorEnablerRules
Description

Tests if this user can perform lookups of job processor enabler/job processor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeJobProcessorEnablerRuleView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryJobProcessorEnablerRuleView
Description

A complete view of the JobProcessorEnabler and JobProcessor returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is 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 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 lookups to this foundry only.

CompliancemandatoryThis method is must be implemented.
MethodgetJobProcessorEnablerIdsForJobProcessor
Description

Gets the JobProcessorEnabler Id associated with a JobProcessor.

Parametersosid.id.IdjobProcessorId Id of the JobProcessor
Returnosid.id.IdListthe job processor enabler Ids
ErrorsNOT_FOUND jobProcessorId is not found
NULL_ARGUMENT jobProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorEnablersForJobProcessor
Description

Gets the JobProcessorEnabler associated with a JobProcessor.

Parametersosid.id.IdjobProcessorId Id of the JobProcessor
Returnosid.resourcing.rules.JobProcessorEnablerListthe job processor enablers
ErrorsNOT_FOUND jobProcessorId is not found
NULL_ARGUMENT jobProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorIdsForJobProcessorEnabler
Description

Gets the JobProcessor Ids mapped to a JobProcessorEnabler.

Parametersosid.id.IdjobProcessorEnablerId Id of a JobProcessorEnabler
Returnosid.id.IdListlist of job processor Ids
ErrorsNOT_FOUND jobProcessorEnablerId is not found
NULL_ARGUMENT jobProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobProcessorsForJobProcessorEnabler
Description

Gets the JobProcessors mapped to a JobProcessorEnabler.

Parametersosid.id.IdjobProcessorEnablerId Id of a JobProcessorEnabler
Returnosid.resourcing.rules.JobProcessorListlist of job processors
ErrorsNOT_FOUND jobProcessorEnablerId is not found
NULL_ARGUMENT jobProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.