org.osid.configuration.rules

Interface ParameterProcessorEnablerConfigurationAssignmentSession

All Superinterfaces:

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

public interface ParameterProcessorEnablerConfigurationAssignmentSession
extends OsidSession

This session provides methods to re-assign ParameterProcessorEnabler to Configuration mappings. A ParameterProcessorEnabler may appear in multiple Configuration objects and removing the last reference to a ParameterProcessorEnabler is the equivalent of deleting it. Each Configuration may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a ParameterProcessorEnabler to another Configuration is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignParameterProcessorEnablerToConfiguration(Id parameterProcessorEnablerId, Id configurationId) Adds an existing ParameterProcessorEnabler to an Configuration.
boolean	canAssignParameterProcessorEnablers() Tests if this user can alter parameter processor enabler/configuration mappings.
boolean	canAssignParameterProcessorEnablersToConfiguration(Id configurationId) Tests if this user can alter parameter processor enabler/configuration mappings.
IdList	getAssignableConfigurationIds(Id configurationId) Gets a list of configurations including and under the given configuration node in which any parameter processor enabler can be assigned.
IdList	getAssignableConfigurationIdsForParameterProcessorEnabler(Id configurationId, Id parameterProcessorEnablerId) Gets a list of configurations including and under the given configuration node in which a specific parameter processor enabler can be assigned.
void	unassignParameterProcessorEnablerFromConfiguration(Id parameterProcessorEnablerId, Id configurationId) Removes a ParameterProcessorEnabler from an Configuration.

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

canAssignParameterProcessorEnablers

boolean canAssignParameterProcessorEnablers()

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

canAssignParameterProcessorEnablersToConfiguration

boolean canAssignParameterProcessorEnablersToConfiguration(Id configurationId)

Tests if this user can alter parameter processor enabler/configuration 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:

configurationId - the Id of the Configuration

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - configurationId is null

Compliance:

mandatory - This method must be implemented.

getAssignableConfigurationIds

IdList getAssignableConfigurationIds(Id configurationId)
                                     throws OperationFailedException

Gets a list of configurations including and under the given configuration node in which any parameter processor enabler can be assigned.

Parameters:

configurationId - the Id of the Configuration

Returns:

list of assignable configuration Ids

Throws:

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableConfigurationIdsForParameterProcessorEnabler

IdList getAssignableConfigurationIdsForParameterProcessorEnabler(Id configurationId,
                                                               Id parameterProcessorEnablerId)
                                                                 throws OperationFailedException

Gets a list of configurations including and under the given configuration node in which a specific parameter processor enabler can be assigned.

Parameters:

configurationId - the Id of the Configuration

parameterProcessorEnablerId - the Id of the ParameterProcessorEnabler

Returns:

list of assignable configuration Ids

Throws:

NullArgumentException - configurationId or parameterProcessorEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignParameterProcessorEnablerToConfiguration

void assignParameterProcessorEnablerToConfiguration(Id parameterProcessorEnablerId,
                                                  Id configurationId)
                                                    throws AlreadyExistsException,
                                                           NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Adds an existing ParameterProcessorEnabler to an Configuration.

Parameters:

parameterProcessorEnablerId - the Id of the ParameterProcessorEnabler

configurationId - the Id of the Configuration

Throws:

AlreadyExistsException - parameterProcessorEnablerId is already assigned to configurationId

NotFoundException - parameterProcessorEnablerId or configurationId not found

NullArgumentException - parameterProcessorEnablerId or configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignParameterProcessorEnablerFromConfiguration

void unassignParameterProcessorEnablerFromConfiguration(Id parameterProcessorEnablerId,
                                                      Id configurationId)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Removes a ParameterProcessorEnabler from an Configuration.

Parameters:

parameterProcessorEnablerId - the Id of the ParameterProcessorEnabler

configurationId - the Id of the Configuration

Throws:

NotFoundException - parameterProcessorEnablerId or configurationId or parameterProcessorEnablerId is not assigned to configurationId

NullArgumentException - parameterProcessorEnablerId or configurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.