Interface ProcedureLookupSession

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

This session defines methods for retrieving procedures.

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 cookbook view: All procedure methods in this session operate, retrieve and pertain to procedures defined explicitly in the current cookbook. Using an isolated view is useful for managing procedures with the ProcedureAdminSession .
  • federated cookbook view: All procedure lookup methods in this session operate, retrieve and pertain to all procedures defined in this cookbook and any other cookbooks implicitly available in this cookbook through cookbook inheritence.

The methods useFederatedCookbookView() and useIsolatedCookbookView() behave as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getCookbookId

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

    • getCookbook

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

    • canLookupProcedures

      boolean canLookupProcedures()
      Tests if this user can lookup procedures. 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 these operations.
      Returns:
      false if procedure lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeProcedureView

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

    • usePlenaryProcedureView

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

    • useFederatedCookbookView

      void useFederatedCookbookView()
      Federates the view for methods in this session. A federated view will include procedures in cookbooks which are children of this cookbook in the cookbook hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCookbookView

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

    • getProcedure

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

    • getProceduresByIds

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

    • getProceduresByGenusType

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

    • getProceduresByParentGenusType

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

    • getProceduresByRecordType

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

    • getProcedures

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