public interface JobResourcingSession extends OsidSession
This session defines methods for resourcing jobs. A more detailed assignment service can be managed through the Resourcing OSID.
Modifier and Type | Method and Description |
---|---|
void |
assignResource(Id resourceId)
Assigns a
Resource to this job. |
boolean |
canResourceJobs()
Tests if this user can assign
Resources to this job. |
Foundry |
getJob()
Gets the
Job associated with this session. |
Id |
getJobId()
Gets the
Job Id associated with this
session. |
ResourceList |
getResources()
Gets a list of resource assigned in this job.
|
void |
unassignResource(Id resourceId)
Unassigns a
Resource from this job. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getJobId()
Job
Id
associated with this
session. Job Id
associated with this sessionmandatory
- This method must be implemented. Foundry getJob() throws OperationFailedException, PermissionDeniedException
Job
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canResourceJobs()
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. false
if resource assignment methods are not
authorized, true
otherwisemandatory
- This method must be implemented. ResourceList getResources() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void assignResource(Id resourceId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Resource
to this job.resourceId
- the Id
of the Resource
AlreadyExistsException
- resourceId
already assigned to this jobNotFoundException
- resourceId
not foundNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignResource(Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Resource
from this job.resourceId
- the Id
of the Resource
NotFoundException
- resourceId
not
assigned to this jobNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.