Interface StepConstrainerEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
StepConstrainerEnablerSearchSession
public interface StepConstrainerEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchStepConstrainerEnablers

      boolean canSearchStepConstrainerEnablers()
      Tests if this user can perform StepConstrainerEnabler 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 constrainer 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.

    • getStepConstrainerEnablerQuery

      StepConstrainerEnablerQuery getStepConstrainerEnablerQuery()
      Gets a step constrainer enabler query.
      Returns:
      the step constrainer enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getStepConstrainerEnablersByQuery

      StepConstrainerEnablerList getStepConstrainerEnablersByQuery(StepConstrainerEnablerQuery stepConstrainerEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of StepConstrainerEnablers matching the given step constrainer enabler query.
      Parameters:
      stepConstrainerEnablerQuery - the sestep constrainer enabler query
      Returns:
      the returned StepConstrainerEnablerList
      Throws:
      NullArgumentException - stepConstrainerEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - stepConstrainerEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.