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

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

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

Tests if this user can alter job constrainer/job mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignJobConstrainerToJob
Description

Adds an existing JobConstrainer to a Job.

Parametersosid.id.IdjobConstrainerIdthe Id of the JobConstrainer
osid.id.IdjobIdthe Id of the Job
ErrorsALREADY_EXISTS jobConstrainerId is already applied to jobId
NOT_FOUND jobConstrainerId or jobId not found
NULL_ARGUMENT jobConstrainerId or jobId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignJobConstrainerFromJob
Description

Removes a JobConstrainer from a Job.

Parametersosid.id.IdjobConstrainerIdthe Id of the JobConstrainer
osid.id.IdjobIdthe Id of the Job
ErrorsNOT_FOUND jobConstrainerId or jobId not found or jobConstrainerId not applied to jobId
NULL_ARGUMENT jobConstrainerId or jobId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceJobConstrainers
Description

Tests if this user can order JobConstrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if JobConstrainer ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveJobConstrainerAhead
Description

Reorders job constrainers for a job constrainer by moving the specified job constrainer in front of a reference job constrainer.

Parametersosid.id.IdjobConstrainerIdthe Id of a JobConstrainer
osid.id.IdjobIdthe Id of a Job
osid.id.IdreferenceIdthe reference job constrainer Id
ErrorsNOT_FOUND jobConstrainerId, jobId, or referenceId not found or, jobConstrainerId or referenceId not related to jobId
NULL_ARGUMENT jobConstrainerId, jobId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveJobConstrainerBehind
Description

Reorders job constrainers for a job constrainer by moving the specified job constrainer behind a reference job constrainer.

Parametersosid.id.IdjobConstrainerIdthe Id of a JobConstrainer
osid.id.IdjobIdthe Id of a Job
osid.id.IdreferenceIdthe reference job constrainer Id
ErrorsNOT_FOUND jobConstrainerId, jobId, or referenceId not found or, jobConstrainerId or referenceId not related to jobId
NULL_ARGUMENT jobConstrainerId, jobId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderJobConstrainers
Description

Reorders a set of job constrainer for a job.

Parametersosid.id.Id[]jobConstrainerIdsthe Ids for a set of JobConstrainers
osid.id.IdjobIdthe Id of a Job
ErrorsNOT_FOUND jobId not found or, a jobConstrainerId not related to jobId
NULL_ARGUMENT jobConstrainerIds or jobId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.