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

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

MethodcanAssignJobProcessorEnablers
Description

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

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

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

Parametersosid.id.IdfoundryIdthe Id of the Foundry
osid.id.IdjobProcessorEnablerIdthe Id of the JobProcessorEnabler
Returnosid.id.IdListlist of assignable foundry Ids
ErrorsNULL_ARGUMENT foundryId or jobProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignJobProcessorEnablerToFoundry
Description

Adds an existing JobProcessorEnabler to a Foundry.

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

Removes a JobProcessorEnabler from a Foundry.

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