Interface JobResourcingSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface JobResourcingSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getJobId

Id getJobId()

Gets the Job Id associated with this session.

Returns:

the Job Id associated with this session

Compliance:

mandatory - This method must be implemented.

getJob

Foundry getJob()
        throws OperationFailedException,
PermissionDeniedException

Gets the Job associated with this session.

Returns:

the foundry

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canResourceJobs

boolean canResourceJobs()

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.

Returns:

false if resource assignment methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getResources

ResourceList getResources()
                   throws OperationFailedException,
PermissionDeniedException

Gets a list of resource assigned in this job.

Returns:

a list of resources

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

assignResource

void assignResource(Id resourceId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Assigns a Resource to this job.

Parameters:

resourceId - the Id of the Resource

Throws:

AlreadyExistsException - resourceId already assigned to this job

NotFoundException - resourceId not found

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignResource

void unassignResource(Id resourceId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Unassigns a Resource from this job.

Parameters:

resourceId - the Id of the Resource

Throws:

NotFoundException - resourceId not assigned to this job

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.