Interface StepQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
StepSearchSession
public interface StepQuerySession extends OsidSession

This session provides methods for searching among Steps. The search query is constructed using the StepQuery.

This session defines views that offer differing behaviors for searching.

  • federated office view: searches include steps in offices of which this office is an ancestor in the office hierarchy
  • isolated office view: searches are restricted to steps in this office

Steps may have a query record indicated by their respective record types. The query record is accessed via the StepQuery.

  • Method Details

    • getOfficeId

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

    • getOffice

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

    • canSearchSteps

      boolean canSearchSteps()
      Tests if this user can perform Step 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 not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedOfficeView

      void useFederatedOfficeView()
      Federates the view for methods in this session. A federated view will include steps in offices which are children of this office in the office hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedOfficeView

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

    • getStepQuery

      StepQuery getStepQuery()
      Gets a step query.
      Returns:
      the step query
      Compliance:
      mandatory - This method must be implemented.

    • getStepsByQuery

      StepList getStepsByQuery(StepQuery stepQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Steps matching the given step query.
      Parameters:
      stepQuery - the step query
      Returns:
      the returned StepList
      Throws:
      NullArgumentException - stepQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - stepQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.