OSID Logo
OSID Specifications
resourcing rules package
Version 3.0.0
Interfaceosid.resourcing.rules.JobProcessorEnablerRuleApplicationSession
Implementsosid.OsidSession
Used Byosid.resourcing.rules.ResourcingRulesManager
osid.resourcing.rules.ResourcingRulesProxyManager
Description

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

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

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

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignJobProcessorEnablerToJobProcessor
Description

Adds an existing JobProcessorEnabler to a JobProcessor .

Parametersosid.id.IdjobProcessorEnablerIdthe Id of the JobProcessorEnabler
osid.id.IdjobProcessorIdthe Id of the JobProcessor
ErrorsALREADY_EXISTSjobProcessorEnablerId is already applied to jobProcessorId
NOT_FOUNDjobProcessorEnablerId or jobProcessorId not found
NULL_ARGUMENTjobProcessorEnablerId or jobProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignJobProcessorEnablerFromJobProcessor
Description

Removes a JobProcessorEnabler from a JobProcessor .

Parametersosid.id.IdjobProcessorEnablerIdthe Id of the JobProcessorEnabler
osid.id.IdjobProcessorIdthe Id of the JobProcessor
ErrorsNOT_FOUNDjobProcessorEnablerId or jobProcessorId not found or jobProcessorEnablerId not applied to jobProcessorId
NULL_ARGUMENTjobProcessorEnablerId or jobProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceJobProcessorEnablers
Description

Tests if this user can order JobProcessorEnablers . 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.

Returnbooleanfalse if JobProcessornEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveJobProcessorEnablerAhead
Description

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

Parametersosid.id.IdjobProcessorEnablerIdthe Id of a JobProcessorEnabler
osid.id.IdjobProcessorIdthe Id of a JobProcessor
osid.id.IdreferenceIdthe reference job processor enabler Id
ErrorsNOT_FOUNDjobProcessorEnablerId, jobProcessorId , or referenceId not found or, jobProcessorEnablerId or referenceId not related to jobProcessorId
NULL_ARGUMENTjobProcessorEnablerId, jobProcessorId , or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveJobProcessorEnablerBehind
Description

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

Parametersosid.id.IdjobProcessorEnablerIdthe Id of a JobProcessorEnabler
osid.id.IdjobProcessorIdthe Id of a JobProcessor
osid.id.IdreferenceIdthe reference job processor enabler Id
ErrorsNOT_FOUNDjobProcessorEnablerId, jobProcessorId , or referenceId not found or, jobProcessorEnablerId or referenceId not related to jobProcessorId
NULL_ARGUMENTjobProcessorEnablerId, jobProcessorId , or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderJobProcessorEnablers
Description

Reorders a set of job processor enablers for a job processor.

Parametersosid.id.Id[]jobProcessorEnablerIdsthe Ids for a set of JobProcessorEnablers
osid.id.IdjobProcessorIdthe Id of a JobProcessor
ErrorsNOT_FOUNDjobProcessorId not found or, a jobProcessorEnablerId not related to jobProcessorId
NULL_ARGUMENTjobProcessorEnablerIds or jobProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.