org.osid.resourcing

Interface JobFoundryAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface JobFoundryAssignmentSession
extends OsidSession

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 ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignJobToFoundry(Id jobId, Id foundryId) Adds an existing Job to a Foundry.
boolean	canAssignJobs() Tests if this user can alter job/foundry mappings.
boolean	canAssignJobsToFoundry(Id foundryId) Tests if this user can alter job/foundry mappings.
IdList	getAssignableFoundryIds(Id foundryId) Gets a list of foundries including and under the given foundry node in which any job can be assigned.
IdList	getAssignableFoundryIdsForJob(Id foundryId, Id jobId) Gets a list of foundries including and under the given foundry node in which a specific job can be assigned.
void	unassignJobFromFoundry(Id jobId, Id foundryId) Removes a Job from a Foundry.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canAssignJobs

boolean canAssignJobs()

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.

Returns:

false if resourcing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignJobsToFoundry

boolean canAssignJobsToFoundry(Id foundryId)

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.

Parameters:

foundryId - the Id of the Foundry

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - foundryId is null

Compliance:

mandatory - This method must be implemented.

getAssignableFoundryIds

IdList getAssignableFoundryIds(Id foundryId)
                               throws OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

Returns:

list of assignable foundry Ids

Throws:

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableFoundryIdsForJob

IdList getAssignableFoundryIdsForJob(Id foundryId,
                                   Id jobId)
                                     throws OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

jobId - the Id of the Job

Returns:

list of assignable foundry Ids

Throws:

NullArgumentException - foundryId or jobId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignJobToFoundry

void assignJobToFoundry(Id jobId,
                      Id foundryId)
                        throws NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Adds an existing Job to a Foundry.

Parameters:

jobId - the Id of the Job

foundryId - the Id of the Foundry

Throws:

NotFoundException - jobId or foundryId not found

NullArgumentException - jobId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignJobFromFoundry

void unassignJobFromFoundry(Id jobId,
                          Id foundryId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Removes a Job from a Foundry.

Parameters:

jobId - the Id of the Job

foundryId - the Id of the Foundry

Throws:

NotFoundException - jobId or foundryId not found

NullArgumentException - jobId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.