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

This session provides methods to re-assign JobConstrainerEnabler to Foundry mappings. A JobConstrainerEnabler may appear in multiple Foundry objects and removing the last reference to a JobConstrainerEnabler 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 JobConstrainerEnabler to another Foundry is not a copy operation (eg: does not change its Id ).

MethodcanAssignJobConstrainerEnablers
Description

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

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

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

Parametersosid.id.IdfoundryIdthe Id of the Foundry
osid.id.IdjobConstrainerEnablerIdthe Id of the JobConstrainerEnabler
Returnosid.id.IdListlist of assignable foundry Ids
ErrorsNULL_ARGUMENT foundryId or jobConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignJobConstrainerEnablerToFoundry
Description

Adds an existing JobConstrainerEnabler to a Foundry.

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

Removes a JobConstrainerEnabler from a Foundry.

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