Interface ParameterProcessorEnablerConfigurationAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, 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

Modifier and Type	Method	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	reassignParameterProcessorEnablerToConfiguration(Id parameterProcessorEnablerId, Id fromConfigurationId, Id toConfigurationId)	Moves a ParameterProcessorEnabler from one Configuration to another.
void	unassignParameterProcessorEnablerFromConfiguration(Id parameterProcessorEnablerId, Id configurationId)	Removes a ParameterProcessorEnabler from an Configuration .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.

reassignParameterProcessorEnablerToConfiguration

void reassignParameterProcessorEnablerToConfiguration(Id parameterProcessorEnablerId,
 Id fromConfigurationId,
 Id toConfigurationId)
                                               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves a ParameterProcessorEnabler from one Configuration to another. Mappings to other Configurations are unaffected.

Parameters:

parameterProcessorEnablerId - the Id of the ParameterProcessorEnabler

fromConfigurationId - the Id of the current Configuration

toConfigurationId - the Id of the destination Configuration

Throws:

AlreadyExistsException - parameterProcessorEnablerId already assigned to toConfigurationId

NotFoundException - parameterProcessorEnablerId, fromConfigurationId , or toConfigurationId not found or parameparameterProcessorEnablerIdterProcessorId not mapped to fromConfigurationId

NullArgumentException - parameterProcessorEnablerId, fromConfigurationId , or toConfigurationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.