org.osid.resourcing.rules

Interface JobConstrainerFoundryAssignmentSession

All Superinterfaces:

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

public interface JobConstrainerFoundryAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignJobConstrainerToFoundry(Id jobConstrainerId, Id foundryId) Adds an existing JobConstrainer to a Foundry.
boolean	canAssignJobConstrainers() Tests if this user can alter job constrainer/foundry mappings.
boolean	canAssignJobConstrainersToFoundry(Id foundryId) Tests if this user can alter job constrainer/foundry mappings.
IdList	getAssignableFoundryIds(Id foundryId) Gets a list of foundries including and under the given foundry node in which any job constrainer can be assigned.
IdList	getAssignableFoundryIdsForJobConstrainer(Id foundryId, Id jobConstrainerId) Gets a list of foundries including and under the given foundry node in which a specific job constrainer can be assigned.
void	unassignJobConstrainerFromFoundry(Id jobConstrainerId, Id foundryId) Removes a JobConstrainer 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

canAssignJobConstrainers

boolean canAssignJobConstrainers()

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

canAssignJobConstrainersToFoundry

boolean canAssignJobConstrainersToFoundry(Id foundryId)

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

getAssignableFoundryIdsForJobConstrainer

IdList getAssignableFoundryIdsForJobConstrainer(Id foundryId,
                                              Id jobConstrainerId)
                                                throws OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

jobConstrainerId - the Id of the JobConstrainer

Returns:

list of assignable foundry Ids

Throws:

NullArgumentException - foundryId or jobConstrainerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignJobConstrainerToFoundry

void assignJobConstrainerToFoundry(Id jobConstrainerId,
                                 Id foundryId)
                                   throws AlreadyExistsException,
                                          NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Adds an existing JobConstrainer to a Foundry.

Parameters:

jobConstrainerId - the Id of the JobConstrainer

foundryId - the Id of the Foundry

Throws:

AlreadyExistsException - jobConstrainerId is already assigned to foundryId

NotFoundException - jobConstrainerId or foundryId not found

NullArgumentException - jobConstrainerId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignJobConstrainerFromFoundry

void unassignJobConstrainerFromFoundry(Id jobConstrainerId,
                                     Id foundryId)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Removes a JobConstrainer from a Foundry.

Parameters:

jobConstrainerId - the Id of the JobConstrainer

foundryId - the Id of the Foundry

Throws:

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

NullArgumentException - jobConstrainerId or foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.