OSID Logo
OSID Specifications
resourcing package
Version 3.1.0
Interfaceosid.resourcing.JobFoundryAssignmentSession
Implementsosid.OsidSession
Used Byosid.resourcing.ResourcingManager
osid.resourcing.ResourcingProxyManager
Description

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

MethodcanAssignJobs
Description

Tests if this user can alter job/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 assignment operations to unauthorized users.

Returnboolean false if resourcing is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignJobsToFoundry
Description

Tests if this user can alter job/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 assignment operations to unauthorized users.

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

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

Parametersosid.id.IdfoundryId the Id of the Foundry
Returnosid.id.IdList list of assignable foundry Ids
ErrorsNULL_ARGUMENT foundryId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableFoundryIdsForJob
Description

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

Parametersosid.id.IdfoundryId the Id of the Foundry
osid.id.IdjobId the Id of the Job
Returnosid.id.IdList list of assignable foundry Ids
ErrorsNULL_ARGUMENT foundryId or jobId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignJobToFoundry
Description

Adds an existing Job to a Foundry.

Parametersosid.id.IdjobId the Id of the Job
osid.id.IdfoundryId the Id of the Foundry
ErrorsNOT_FOUND jobId or foundryId not found
NULL_ARGUMENT jobId or foundryId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignJobFromFoundry
Description

Removes a Job from a Foundry .

Parametersosid.id.IdjobId the Id of the Job
osid.id.IdfoundryId the Id of the Foundry
ErrorsNOT_FOUND jobId or foundryId not found
NULL_ARGUMENT jobId or foundryId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignJobToFoundry
Description

Moves a Job from one Foundry to another. Mappings to other Foundries are unaffected.

Parametersosid.id.IdjobId the Id of the Job
osid.id.IdfromFoundryId the Id of the current Foundry
osid.id.IdtoFoundryId the Id of the destination Foundry
ErrorsALREADY_EXISTS jobId already assigned to toFoundryId
NOT_FOUND jobId, fromFoundryId, or toFoundryId not found or jobId not mapped to fromFoundryId
NULL_ARGUMENT jobId, fromFoundryId, or toFoundryId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.