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

This session provides methods to re-assign JobConstrainer to Foundry mappings. A JobConstrainer may appear in multiple Foundry objects and removing the last reference to a JobConstrainer is the equivalent of deleting it. Each Foundry may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a JobConstrainer to another Foundry is not a copy operation (eg: does not change its Id ).

MethodcanAssignJobConstrainers
Description

Tests if this user can alter job constrainer/foundry 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.
MethodcanAssignJobConstrainersToFoundry
Description

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

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT foundryId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableFoundryIds
Description

Gets a list of foundries including and under the given foundry node in which any job constrainer can be assigned.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.id.IdListlist of assignable foundry Ids
ErrorsNULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableFoundryIdsForJobConstrainer
Description

Gets a list of foundries including and under the given foundry node in which a specific job constrainer can be assigned.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
osid.id.IdjobConstrainerIdthe Id of the JobConstrainer
Returnosid.id.IdListlist of assignable foundry Ids
ErrorsNULL_ARGUMENT foundryId or jobConstrainerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignJobConstrainerToFoundry
Description

Adds an existing JobConstrainer to a Foundry.

Parametersosid.id.IdjobConstrainerIdthe Id of the JobConstrainer
osid.id.IdfoundryIdthe Id of the Foundry
ErrorsALREADY_EXISTS jobConstrainerId is already assigned to foundryId
NOT_FOUND jobConstrainerId or foundryId not found
NULL_ARGUMENT jobConstrainerId or foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignJobConstrainerFromFoundry
Description

Removes a JobConstrainer from a Foundry.

Parametersosid.id.IdjobConstrainerIdthe Id of the JobConstrainer
osid.id.IdfoundryIdthe Id of the Foundry
ErrorsNOT_FOUND jobConstrainerId or foundryId not found or jobConstrainerId not assigned to foundryId
NULL_ARGUMENT jobConstrainerId or foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.