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

This session defines methods for resourcing jobs. A more detailed assignment service can be managed through the Resourcing OSID.

MethodgetJobId
Description

Gets the Job Id associated with this session.

Returnosid.id.Idthe Job Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetJob
Description

Gets the Job associated with this session.

Returnosid.resourcing.Foundrythe foundry
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanResourceJobs
Description

Tests if this user can assign Resources to this job. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer assignment operations to unauthorized users.

Returnboolean false if resource assignment methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetResources
Description

Gets a list of resource assigned in this job.

Returnosid.resource.ResourceLista list of resources
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodassignResource
Description

Assigns a Resource to this job.

Parametersosid.id.IdresourceIdthe Id of the Resource
ErrorsALREADY_EXISTS resourceId already assigned to this job
NOT_FOUND resourceId not found
NULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignResource
Description

Unassigns a Resource from this job.

Parametersosid.id.IdresourceIdthe Id of the Resource
ErrorsNOT_FOUND resourceId not assigned to this job
NULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.