Interface StepProcessorEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
StepProcessorEnablerSearchSession
public interface StepProcessorEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchStepProcessorEnablers

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

    • getStepProcessorEnablerQuery

      StepProcessorEnablerQuery getStepProcessorEnablerQuery()
      Gets a step processor enabler query.
      Returns:
      the step processor enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getStepProcessorEnablersByQuery

      StepProcessorEnablerList getStepProcessorEnablersByQuery(StepProcessorEnablerQuery stepProcessorEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of StepProcessorEnablers matching the given step processor enabler query.
      Parameters:
      stepProcessorEnablerQuery - the step processor enabler query
      Returns:
      the returned StepProcessorEnablerList
      Throws:
      NullArgumentException - stepProcessorEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - stepProcessorEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.