org.osid.resourcing.rules

Interface JobProcessorFoundryAssignmentSession

All Superinterfaces:

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

public interface JobProcessorFoundryAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignJobProcessorToFoundry(Id jobProcessorId, Id foundryId) Adds an existing JobProcessor to a Foundry.
boolean	canAssignJobProcessors() Tests if this user can alter job processor/foundry mappings.
boolean	canAssignJobProcessorsToFoundry(Id foundryId) Tests if this user can alter job processor/foundry mappings.
IdList	getAssignableFoundryIds(Id foundryId) Gets a list of foundries including and under the given foundry node in which any job processor can be assigned.
IdList	getAssignableFoundryIdsForJobProcessor(Id foundryId, Id jobProcessorId) Gets a list of foundries including and under the given foundry node in which a specific job processor can be assigned.
void	unassignJobProcessorFromFoundry(Id jobProcessorId, Id foundryId) Removes a JobProcessor 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

canAssignJobProcessors

boolean canAssignJobProcessors()

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

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignJobProcessorsToFoundry

boolean canAssignJobProcessorsToFoundry(Id foundryId)

Tests if this user can alter job processor/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 lookup 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 processor 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.

getAssignableFoundryIdsForJobProcessor

IdList getAssignableFoundryIdsForJobProcessor(Id foundryId,
                                            Id jobProcessorId)
                                              throws OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

jobProcessorId - the Id of the JobProcessor

Returns:

list of assignable foundry Ids

Throws:

NullArgumentException - foundryId or jobProcessorId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignJobProcessorToFoundry

void assignJobProcessorToFoundry(Id jobProcessorId,
                               Id foundryId)
                                 throws AlreadyExistsException,
                                        NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Adds an existing JobProcessor to a Foundry.

Parameters:

jobProcessorId - the Id of the JobProcessor

foundryId - the Id of the Foundry

Throws:

AlreadyExistsException - jobProcessorId is already assigned to foundryId

NotFoundException - jobProcessorId or foundryId not found

NullArgumentException - jobProcessorId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignJobProcessorFromFoundry

void unassignJobProcessorFromFoundry(Id jobProcessorId,
                                   Id foundryId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Removes a JobProcessor from a Foundry.

Parameters:

jobProcessorId - the Id of the JobProcessor

foundryId - the Id of the Foundry

Throws:

NotFoundException - jobProcessorId or foundryId not found or jobProcessorId not assigned to foundryId

NullArgumentException - jobProcessorId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.