Interface StepProcessorQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
StepProcessorSearchSession
public interface StepProcessorQuerySession extends OsidSession

This session provides methods for searching among StepProcessor objects. The search query is constructed using the StepProcessorQuery.

This session defines views that offer differing behaviors for searching.

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

Step processor may have a query record indicated by their respective record types. The query record is accessed via the StepProcessorQuery.

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

    • canSearchStepProcessors

      boolean canSearchStepProcessors()
      Tests if this user can perform StepProcessor 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 step processor in offices which are children of this step 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 lookups to this office only.
      Compliance:
      mandatory - This method is must be implemented.

    • getStepProcessorQuery

      StepProcessorQuery getStepProcessorQuery()
      Gets a step processor query.
      Returns:
      the step processor query
      Compliance:
      mandatory - This method must be implemented.

    • getStepProcessorsByQuery

      StepProcessorList getStepProcessorsByQuery(StepProcessorQuery stepProcessorQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of StepProcessors matching the given step processor query.
      Parameters:
      stepProcessorQuery - the step processor query
      Returns:
      the returned StepProcessorList
      Throws:
      NullArgumentException - stepProcessorQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - stepProcessorQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.