Interface StepEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
StepEnablerSearchSession
public interface StepEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchStepEnablers

      boolean canSearchStepEnablers()
      Tests if this user can perform StepEnabler 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 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 enablers 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.

    • getStepEnablerQuery

      StepEnablerQuery getStepEnablerQuery()
      Gets a step enabler query.
      Returns:
      the step enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getStepEnablersByQuery

      StepEnablerList getStepEnablersByQuery(StepEnablerQuery stepEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of StepEnablers matching the given search.
      Parameters:
      stepEnablerQuery - the step enabler query
      Returns:
      the returned StepEnablerList
      Throws:
      NullArgumentException - stepEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - stepEnablerQuery did not originate from getStepEnablerQuery()
      Compliance:
      mandatory - This method must be implemented.