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

This session provides methods to retrieve JobConstrainerEnabler to JobConstrainer mappings. A JobConstrainer with multiple JobConstrainerEnablers means any positive rule evaluation across the enablers result in an effective JobConstrainer.

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 constrainer enablers defined explicitly in the current foundry
  • federated foundry view: All methods in this session operate, retrieve and pertain to all job constrainer enablers defined in this foundry and any other job constrainer 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.
MethodcanLookupJobConstrainerEnablerRules
Description

Tests if this user can perform lookups of job constrainer enabler/job constrainer 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.
MethoduseComparativeJobConstrainerEnablerRuleView
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.
MethodusePlenaryJobConstrainerEnablerRuleView
Description

A complete view of the JobConstrainerEnabler and JobConstrainer 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 constrainer 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.
MethodgetJobConstrainerEnablerIdsForJobConstrainer
Description

Gets the JobConstrainerEnabler Id associated with a JobConstrainer.

Parametersosid.id.Id jobConstrainerId Id of the JobConstrainer
Returnosid.id.IdListthe job constrainer enabler Ids
ErrorsNOT_FOUND jobConstrainerId is not found
NULL_ARGUMENT jobConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobConstrainerEnablersForJobConstrainer
Description

Gets the JobConstrainerEnablers associated with a JobConstrainer.

Parametersosid.id.IdjobConstrainerId Id of the JobConstrainer
Returnosid.resourcing.rules.JobConstrainerEnablerListthe job constrainer enablers
ErrorsNOT_FOUND jobConstrainerId is not found
NULL_ARGUMENT jobConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobConstrainerIdsForJobConstrainerEnabler
Description

Gets the JobConstrainer Ids mapped to a JobConstrainerEnabler.

Parametersosid.id.IdjobConstrainerEnablerId Id of a JobConstrainerEnabler
Returnosid.id.IdListlist of job constrainer Ids
ErrorsNOT_FOUND jobConstrainerEnablerId is not found
NULL_ARGUMENT jobConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobConstrainersForJobConstrainerEnabler
Description

Gets the JobConstrainers mapped to a JobConstrainerEnabler.

Parametersosid.id.IdjobConstrainerEnablerId Id of a JobConstrainerEnabler
Returnosid.resourcing.rules.JobConstrainerListlist of job constrainers
ErrorsNOT_FOUND jobConstrainerEnablerId is not found
NULL_ARGUMENT jobConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.