Interface ParameterProcessorLookupSession

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

This session provides methods for retrieving ParameterProcessors .

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated configuration view: All parameter processor methods in this session operate, retrieve and pertain to parameter processor defined explicitly in the current configuration. Using an isolated view is useful for managing ParameterProcessors with the ParameterProcessorAdminSession .
  • federated configuration view: All parameter processor 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.
  • active parameter processor view: All parameter processor lookup methods return active parameter processors.
  • any status parameter processor view: Parameter processors of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

  • 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.

    • canLookupParameterProcessors

      boolean canLookupParameterProcessors()
      Tests if this user can perform ParameterProcessors lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeParameterProcessorView

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

    • usePlenaryParameterProcessorView

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

    • useActiveParameterProcessorView

      void useActiveParameterProcessorView()
      Only active parameter processors are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusParameterProcessorView

      void useAnyStatusParameterProcessorView()
      All active and inactive parameter processors are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getParameterProcessor

      ParameterProcessor getParameterProcessor(Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ParameterProcessor specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned ParameterProcessor may have a different Id than requested, such as the case where a duplicate Id was assigned to a ParameterProcessor and retained for compatibility. In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned.
      Parameters:
      parameterProcessorId - Id of the ParameterProcessor
      Returns:
      the parameter processor
      Throws:
      NotFoundException - parameterProcessorId not found
      NullArgumentException - parameterProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getParameterProcessorsByIds

      ParameterProcessorList getParameterProcessorsByIds(IdList parameterProcessorIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a ParameterProcessorList corresponding to the given IdList . In plenary mode, the returned list contains all of the parameter processor specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible ParameterProcessors may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned.
      Parameters:
      parameterProcessorIds - the list of Ids to retrieve
      Returns:
      the returned ParameterProcessor list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - parameterProcessorIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getParameterProcessorsByGenusType

      ParameterProcessorList getParameterProcessorsByGenusType(Type parameterProcessorGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a ParameterProcessorList corresponding to the given parameter processor genus Type which does not include parameter processor of genus types derived from the specified Type . In plenary mode, the returned list contains all known parameter processor or an error results. Otherwise, the returned list may contain only those parameter processor that are accessible through this session. In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned.
      Parameters:
      parameterProcessorGenusType - a parameter processor genus type
      Returns:
      the returned ParameterProcessor list
      Throws:
      NullArgumentException - parameterProcessorGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getParameterProcessorsByParentGenusType

      ParameterProcessorList getParameterProcessorsByParentGenusType(Type parameterProcessorGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a ParameterProcessorList corresponding to the given parameter processor genus Type and include any additional parameter processor with genus types derived from the specified Type . In plenary mode, the returned list contains all known parameter processor or an error results. Otherwise, the returned list may contain only those parameter processor that are accessible through this session. In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned.
      Parameters:
      parameterProcessorGenusType - a parameter processor genus type
      Returns:
      the returned ParameterProcessor list
      Throws:
      NullArgumentException - parameterProcessorGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getParameterProcessorsByRecordType

      ParameterProcessorList getParameterProcessorsByRecordType(Type parameterProcessorRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a ParameterProcessorList containing the given parameter processor record Type . In plenary mode, the returned list contains all known parameter processor or an error results. Otherwise, the returned list may contain only those parameter processor that are accessible through this session. In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned.
      Parameters:
      parameterProcessorRecordType - a parameter processor record type
      Returns:
      the returned ParameterProcessor list
      Throws:
      NullArgumentException - parameterProcessorRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getParameterProcessors

      ParameterProcessorList getParameterProcessors() throws OperationFailedException, PermissionDeniedException
      Gets all ParameterProcessors . In plenary mode, the returned list contains all known parameter processor or an error results. Otherwise, the returned list may contain only those parameter processor that are accessible through this session. In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned.
      Returns:
      the returned ParameterProcessor list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.