Interface ParameterProcessorConfigurationSession

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

This session provides methods to retrieve ParameterProcessor to Configuration mappings. A ParameterProcessor may appear in multiple Configuration objects. Each configuration may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition

  • Method Details

    • canLookupParameterProcessorConfigurationMappings

      boolean canLookupParameterProcessorConfigurationMappings()
      Tests if this user can perform lookups of parameter processor/configuration mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeParameterProcessorConfigurationView

      void useComparativeParameterProcessorConfigurationView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryParameterProcessorConfigurationView

      void usePlenaryParameterProcessorConfigurationView()
      A complete view of the ParameterProcessor and Configuration returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • getParameterProcessorIdsByConfiguration

      IdList getParameterProcessorIdsByConfiguration(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of ParameterProcessorIds associated with an Configuration .
      Parameters:
      configurationId - Id of the Configuration
      Returns:
      list of related parameter processor Ids
      Throws:
      NotFoundException - configurationId is not found
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getParameterProcessorsByConfiguration

      ParameterProcessorList getParameterProcessorsByConfiguration(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of parameter processors associated with an Configuration .
      Parameters:
      configurationId - Id of the Configuration
      Returns:
      list of related parameter processors
      Throws:
      NotFoundException - configurationId is not found
      NullArgumentException - configurationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getParameterProcessorIdsByConfigurations

      IdList getParameterProcessorIdsByConfigurations(IdList configurationIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of ParameterProcessorIds corresponding to a list of Configurations .
      Parameters:
      configurationIds - list of configuration Ids
      Returns:
      list of parameter processor Ids
      Throws:
      NullArgumentException - configurationIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getParameterProcessorsByConfigurations

      ParameterProcessorList getParameterProcessorsByConfigurations(IdList configurationIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of parameter processor corresponding to a list of Configurations .
      Parameters:
      configurationIds - list of configuration Ids
      Returns:
      list of parameter processors
      Throws:
      NullArgumentException - configurationIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getConfigurationIdsByParameterProcessor

      IdList getConfigurationIdsByParameterProcessor(Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Configuration Ids mapped to a ParameterProcessor .
      Parameters:
      parameterProcessorId - Id of a ParameterProcessor
      Returns:
      list of configurations
      Throws:
      NotFoundException - parameterProcessorId is not found
      NullArgumentException - parameterProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getConfigurationsByParameterProcessor

      ConfigurationList getConfigurationsByParameterProcessor(Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Configurations mapped to a ParameterProcessor .
      Parameters:
      parameterProcessorId - Id of a ParameterProcessor
      Returns:
      list of configurations
      Throws:
      NotFoundException - parameterProcessorId is not found
      NullArgumentException - parameterProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.