Interface ProcessEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ProcessEnablerSearchSession
public interface ProcessEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchProcessEnablers

      boolean canSearchProcessEnablers()
      Tests if this user can perform ProcessEnabler 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 process enabler in offices which are children of this broker 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.

    • getProcessEnablerQuery

      ProcessEnablerQuery getProcessEnablerQuery()
      Gets a process enabler query.
      Returns:
      the process enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getProcessEnablersByQuery

      ProcessEnablerList getProcessEnablersByQuery(ProcessEnablerQuery processEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of ProcessEnablers matching the given process enabler query.
      Parameters:
      processEnablerQuery - the process enabler query
      Returns:
      the returned ProcessEnablerList
      Throws:
      NullArgumentException - processEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - processEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.