Interface ProcedureQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ProcedureSearchSession
public interface ProcedureQuerySession extends OsidSession

This session provides methods for searching Procedure objects. The search query is constructed using the ProcedureQuery . The procedure record Type also specifies the record for the award query.

Procedures may have a query record indicated by their respective record types. The query record is accessed via the ProcedureQuery . The returns in this session may not be cast directly to these interfaces.

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

    • canSearchProcedures

      boolean canSearchProcedures()
      Tests if this user can perform susbcription searches. 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 not wish to offer search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method 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.

    • getProcedureQuery

      ProcedureQuery getProcedureQuery()
      Gets a procedure query.
      Returns:
      the procedure query
      Compliance:
      mandatory - This method must be implemented.

    • getProceduresByQuery

      ProcedureList getProceduresByQuery(ProcedureQuery procedureQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of procedures matching the given procedure query.
      Parameters:
      procedureQuery - the procedure query
      Returns:
      the returned ProcedureList
      Throws:
      NullArgumentException - procedureQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - procedureQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.