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

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

MethodgetFoundryId
Description

Gets the Foundry Id associated with this session.

Returnosid.id.Id the Foundry Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetFoundry
Description

Gets the Foundry associated with this session.

Returnosid.resourcing.Foundry the foundry
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanAssignJobConstrainerEnablers
Description

Tests if this user can alter job constrainer enabler/job constrainer 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
Compliancemandatory This method must be implemented.
MethodassignJobConstrainerEnablerToJobConstrainer
Description

Adds an existing JobConstrainerEnabler to a JobConstrainer.

Parametersosid.id.IdjobConstrainerEnablerId the Id of the JobConstrainerEnabler
osid.id.IdjobConstrainerId the Id of the JobConstrainer
ErrorsALREADY_EXISTS jobConstrainerEnablerId is already applied to jobConstrainerId
NOT_FOUND jobConstrainerEnablerId or jobConstrainerId not found
NULL_ARGUMENT jobConstrainerEnablerId or jobConstrainerId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignJobConstrainerEnablerFromJobConstrainer
Description

Removes a JobConstrainerEnabler from a JobConstrainer.

Parametersosid.id.IdjobConstrainerEnablerId the Id of the JobConstrainerEnabler
osid.id.IdjobConstrainerId the Id of the JobConstrainer
ErrorsNOT_FOUND jobConstrainerEnablerId or jobConstrainerId not found or jobConstrainerEnablerId not applied to jobConstrainerId
NULL_ARGUMENT jobConstrainerEnablerId or jobConstrainerId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanSequenceJobConstrainerEnablers
Description

Tests if this user can order JobConstrainerEnablers. 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 JobConstrainerEnabler ordering is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodmoveJobConstrainerEnablerAhead
Description

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

Parametersosid.id.IdjobConstrainerEnablerId the Id of a JobConstrainerEnabler
osid.id.IdjobConstrainerId the Id of a JobConstrainer
osid.id.IdreferenceId the reference job constrainer enabler Id
ErrorsNOT_FOUND jobConstrainerEnablerId, jobConstrainenId, or referenceId not found or, jobConstrainerEnablerId or referenceId not related to jobConstrainerId
NULL_ARGUMENT jobConstrainerEnablerId, jobConstrainerId, or referenceId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodmoveJobConstrainerEnablerBehind
Description

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

Parametersosid.id.IdjobConstrainerEnablerId the Id of a JobConstrainerEnabler
osid.id.IdjobConstrainerId the Id of a JobConstrainer
osid.id.IdreferenceId the reference job constrainer enabler Id
ErrorsNOT_FOUND jobConstrainerEnablerId, jobConstrainerId, or referenceId not found or, jobConstrainerEnablerId or referenceId not related to jobConstrainerId
NULL_ARGUMENT jobConstrainerEnablerId, jobConstrainerId, or referenceId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodorderJobConstrainerEnablers
Description

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

Parametersosid.id.Id[]jobConstrainerEnablerIds the Ids for a set of JobConstrainerEnablers
osid.id.IdjobConstrainerId the Id of a JobConstrainer
ErrorsNOT_FOUND jobConstrainerId not found or, a jobConstrainerEnablerId not related to jobConstrainerId
NULL_ARGUMENT jobConstrainerEnablerIds or jobConstrainerId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.