Interface ParameterProcessorRuleLookupSession

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

This session provides methods to retrieve ParameterProcessor to Parameter mappings.

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
  • isolated configuration view: All methods in this session operate, retrieve and pertain parameter processor defined explicitly in the current configuration
  • federated configuration view: All methods in this session operate, retrieve and pertain to all parameter processor defined in this configuration and any other parameter processor implicitly available in this configuration through configuration inheritence.

  • Method Details

    • getConfigurationId

      Id getConfigurationId()
      Gets the Configuration Id associated with this session.
      Returns:
      the Configuration Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getConfiguration

      Configuration getConfiguration() throws OperationFailedException, PermissionDeniedException
      Gets the Configuration associated with this session.
      Returns:
      the configuration
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupParameterProcessorRules

      boolean canLookupParameterProcessorRules()
      Tests if this user can perform lookups of parameter processor/parameter 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.

    • useComparativeParameterProcessorRuleView

      void useComparativeParameterProcessorRuleView()
      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.

    • usePlenaryParameterProcessorRuleView

      void usePlenaryParameterProcessorRuleView()
      A complete view of the ParameterProcessor and Parameter 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.

    • useFederatedConfigurationView

      void useFederatedConfigurationView()
      Federates the view for methods in this session. A federated view will include parameter processor in configurations which are children of this configuration in the configuration hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedConfigurationView

      void useIsolatedConfigurationView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this configuration only.
      Compliance:
      mandatory - This method is must be implemented.

    • getParameterProcessorIdsForParameter

      IdList getParameterProcessorIdsForParameter(Id parameterId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ParameterProcessor Id associated with a Parameter .
      Parameters:
      parameterId - Id of the Parameter
      Returns:
      the parameter processor Ids
      Throws:
      NotFoundException - parameterId is not found
      NullArgumentException - parameterId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getParameterProcessorsForParameter

      ParameterProcessorList getParameterProcessorsForParameter(Id parameterId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ParameterProcessor associated with a Parameter .
      Parameters:
      parameterId - Id of the Parameter
      Returns:
      the parameter processors
      Throws:
      NotFoundException - parameterId is not found
      NullArgumentException - parameterId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getParameterIdsForParameterProcessor

      IdList getParameterIdsForParameterProcessor(Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Parameter Ids mapped to an ParameterProcessor .
      Parameters:
      parameterProcessorId - Id of an ParameterProcessor
      Returns:
      list of parameter Ids
      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.

    • getParametersForParameterProcessor

      ParameterList getParametersForParameterProcessor(Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Parameters mapped to an ParameterProcessor .
      Parameters:
      parameterProcessorId - Id of an ParameterProcessor
      Returns:
      list of parameters
      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.