Interface ParameterLookupSession

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

This session provides methods for retrieving Parameters . The Parameter represents a set of idioms.

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 press view: All parameter methods in this session operate, retrieve and pertain to parameters defined explicitly in the current press. Using an isolated view is useful for managing Parameters with the ParameterAdminSession .
  • federated press view: All parameter methods in this session operate, retrieve and pertain to all parameters defined in this press and any other parameters implicitly available in this press through press inheritence.

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

  • Method Details

    • getPressId

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

    • getPress

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

    • canLookupParameters

      boolean canLookupParameters()
      Tests if this user can perform Parameter 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 press 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.

    • useComparativeParameterView

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

    • usePlenaryParameterView

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

    • useFederatedPressView

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

    • useIsolatedPressView

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

    • getParameter

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

    • getParametersByIds

      ParameterList getParametersByIds(IdList parameterIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a ParameterList corresponding to the given IdList . In plenary mode, the returned list contains all of the parameters 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 Parameters may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      parameterIds - the list of Ids to retrieve
      Returns:
      the returned Parameter list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - parameterIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getParametersByGenusType

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

    • getParametersByParentGenusType

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

    • getParametersByRecordType

      ParameterList getParametersByRecordType(Type parameterRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a ParameterList containing the given parameter record Type . In plenary mode, the returned list contains all known parameters or an error results. Otherwise, the returned list may contain only those parameters that are accessible through this session.
      Parameters:
      parameterRecordType - a parameter record type
      Returns:
      the returned Parameter list
      Throws:
      NullArgumentException - parameterRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getParametersForText

      ParameterList getParametersForText(Id textId) throws OperationFailedException, PermissionDeniedException
      Gets a ParameterList containing the given text. In plenary mode, the returned list contains all known parameters or an error results. Otherwise, the returned list may contain only those parameters that are accessible through this session.
      Parameters:
      textId - a text Id
      Returns:
      the returned Parameter list
      Throws:
      NullArgumentException - textId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getParameters

      ParameterList getParameters() throws OperationFailedException, PermissionDeniedException
      Gets all Parameters . In plenary mode, the returned list contains all known parameters or an error results. Otherwise, the returned list may contain only those parameters that are accessible through this session.
      Returns:
      a list of Parameters
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.