org.osid.resourcing.rules

Interface JobProcessorEnablerFoundryAssignmentSession

All Superinterfaces:

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

public interface JobProcessorEnablerFoundryAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignJobProcessorEnablerToFoundry(Id jobProcessorEnablerId, Id foundryId) Adds an existing JobProcessorEnabler to a Foundry.
boolean	canAssignJobProcessorEnablers() Tests if this user can alter job processor enabler/foundry mappings.
boolean	canAssignJobProcessorEnablersToFoundry(Id foundryId) Tests if this user can alter job processor enabler/foundry mappings.
IdList	getAssignableFoundryIds(Id foundryId) Gets a list of foundries including and under the given foundry node in which any job processor enabler can be assigned.
IdList	getAssignableFoundryIdsForJobProcessorEnabler(Id foundryId, Id jobProcessorEnablerId) Gets a list of foundries including and under the given foundry node in which a specific job processor enabler can be assigned.
void	unassignJobProcessorEnablerFromFoundry(Id jobProcessorEnablerId, Id foundryId) Removes a JobProcessorEnabler 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

canAssignJobProcessorEnablers

boolean canAssignJobProcessorEnablers()

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

canAssignJobProcessorEnablersToFoundry

boolean canAssignJobProcessorEnablersToFoundry(Id foundryId)

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

getAssignableFoundryIdsForJobProcessorEnabler

IdList getAssignableFoundryIdsForJobProcessorEnabler(Id foundryId,
                                                   Id jobProcessorEnablerId)
                                                     throws OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

jobProcessorEnablerId - the Id of the JobProcessorEnabler

Returns:

list of assignable foundry Ids

Throws:

NullArgumentException - foundryId or jobProcessorEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignJobProcessorEnablerToFoundry

void assignJobProcessorEnablerToFoundry(Id jobProcessorEnablerId,
                                      Id foundryId)
                                        throws AlreadyExistsException,
                                               NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Adds an existing JobProcessorEnabler to a Foundry.

Parameters:

jobProcessorEnablerId - the Id of the JobProcessorEnabler

foundryId - the Id of the Foundry

Throws:

AlreadyExistsException - jobProcessorEnablerId is already assigned to foundryId

NotFoundException - jobProcessorEnablerId or foundryId not found

NullArgumentException - jobProcessorEnablerId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignJobProcessorEnablerFromFoundry

void unassignJobProcessorEnablerFromFoundry(Id jobProcessorEnablerId,
                                          Id foundryId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Removes a JobProcessorEnabler from a Foundry.

Parameters:

jobProcessorEnablerId - the Id of the JobProcessorEnabler

foundryId - the Id of the Foundry

Throws:

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

NullArgumentException - jobProcessorEnablerId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.