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

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

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

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

A complete view of the JobConstrainer and Job 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 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.
MethodgetJobConstrainerIdsForJob
Description

Gets the JobConstrainer Id associated with a Job.

Parametersosid.id.IdjobId Id of the Job
Returnosid.id.IdListthe job constrainer Ids
ErrorsNOT_FOUND jobId is not found
NULL_ARGUMENT jobId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobConstrainersForJob
Description

Gets the JobConstrainer associated with a Job.

Parametersosid.id.IdjobId Id of the Job
Returnosid.resourcing.rules.JobConstrainerListthe job constrainers
ErrorsNOT_FOUND jobId is not found
NULL_ARGUMENT jobId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetJobIdsForJobConstrainer
Description

Gets the Job Ids mapped to a JobConstrainer.

Parametersosid.id.IdjobConstrainerId Id of a JobConstrainer
Returnosid.id.IdListlist of job 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.
MethodgetJobsForJobConstrainer
Description

Gets the Jobs mapped to a JobConstrainer.

Parametersosid.id.IdjobConstrainerId Id of a JobConstrainer
Returnosid.resourcing.JobListlist of jobs
ErrorsNOT_FOUND jobConstrainerId is not found
NULL_ARGUMENT jobConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.