Interface ParameterProcessorConfigurationAssignmentSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface ParameterProcessorConfigurationAssignmentSession extends OsidSession

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

  • Method Details

    • canAssignParameterProcessors

      boolean canAssignParameterProcessors()
      Tests if this user can alter parameter processor/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.

    • canAssignParameterProcessorsToConfiguration

      boolean canAssignParameterProcessorsToConfiguration(Id configurationId)
      Tests if this user can alter parameter processor/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 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.

    • getAssignableConfigurationIdsForParameterProcessor

      IdList getAssignableConfigurationIdsForParameterProcessor(Id configurationId, Id parameterProcessorId) throws OperationFailedException
      Gets a list of configurations including and under the given configuration node in which a specific parameter processor can be assigned.
      Parameters:
      configurationId - the Id of the Configuration
      parameterProcessorId - the Id of the ParameterProcessor
      Returns:
      list of assignable configuration Ids
      Throws:
      NullArgumentException - configurationId or parameterProcessorId is null
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • assignParameterProcessorToConfiguration

      void assignParameterProcessorToConfiguration(Id parameterProcessorId, Id configurationId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an existing ParameterProcessor to an Configuration .
      Parameters:
      parameterProcessorId - the Id of the ParameterProcessor
      configurationId - the Id of the Configuration
      Throws:
      AlreadyExistsException - parameterProcessorId is already assigned to configurationId
      NotFoundException - parameterProcessorId or configurationId not found
      NullArgumentException - parameterProcessorId or configurationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • unassignParameterProcessorFromConfiguration

      void unassignParameterProcessorFromConfiguration(Id parameterProcessorId, Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Removes a ParameterProcessor from a Configuration .
      Parameters:
      parameterProcessorId - the Id of the ParameterProcessor
      configurationId - the Id of the Configuration
      Throws:
      NotFoundException - parameterProcessorId or configurationId not found or parameterProcessorId is not assigned to configurationId
      NullArgumentException - parameterProcessorId or configurationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • reassignParameterProcessorToConfiguration

      void reassignParameterProcessorToConfiguration(Id parameterProcessorId, Id fromConfigurationId, Id toConfigurationId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Moves a ParameterProcessor from one Configuration to another. Mappings to other Configurations are unaffected.
      Parameters:
      parameterProcessorId - the Id of the ParameterProcessor
      fromConfigurationId - the Id of the current Configuration
      toConfigurationId - the Id of the destination Configuration
      Throws:
      AlreadyExistsException - parameterProcessorId already assigned to toConfigurationId
      NotFoundException - parameterProcessorId fromConfigurationId , or toConfigurationId not found or parameterProcessorId not mapped to fromConfigurationId
      NullArgumentException - parameterProcessorId, fromConfigurationId , or toConfigurationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.