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

This session provides methods to apply JobProcessors to Jobs.

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

Tests if this user can alter job processor/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.
MethodassignJobProcessorToJob
Description

Adds an existing JobProcessor to a Job.

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

Removes a JobProcessor from a Job.

Parametersosid.id.IdjobProcessorIdthe Id of the JobProcessor
osid.id.IdjobIdthe Id of the Job
ErrorsNOT_FOUND jobProcessorId or jobId not found or jobProcessorId not applied to jobId
NULL_ARGUMENT jobProcessorId or jobId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceJobProcessors
Description

Tests if this user can order JobProcessors. 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 JobProcessor ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveJobProcessorAhead
Description

Reorders job processors for a job by moving the specified job enabler in front of a reference job processor.

Parametersosid.id.IdjobProcessorIdthe Id of a JobProcessor
osid.id.IdjobIdthe Id of a Job
osid.id.IdreferenceIdthe reference job processor Id
ErrorsNOT_FOUND jobProcessorId, jobId, or referenceId not found or, jobProcessorId or referenceId not related to jobId
NULL_ARGUMENT jobProcessorId, jobId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveJobProcessorBehind
Description

Reorders job processors for a job by moving the specified job enabler behind a reference job processor.

Parametersosid.id.IdjobProcessorIdthe Id of a JobProcessor
osid.id.IdjobIdthe Id of a Job
osid.id.IdreferenceIdthe reference job processor Id
ErrorsNOT_FOUND jobProcessorId, jobId, or referenceId not found or, jobProcessorId or referenceId not related to jobId
NULL_ARGUMENT jobProcessorId, jobId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderJobProcessors
Description

Reorders a set of job processors for a job.

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