Interface ProcessProcessorEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ProcessProcessorEnablerSearchSession
public interface ProcessProcessorEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchProcessProcessorEnablers

      boolean canSearchProcessProcessorEnablers()
      Tests if this user can perform ProcessProcessorEnabler 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 process processor 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.

    • getProcessProcessorEnablerQuery

      ProcessProcessorEnablerQuery getProcessProcessorEnablerQuery()
      Gets a process processor enabler query.
      Returns:
      the process processor enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessorEnablersByQuery

      ProcessProcessorEnablerList getProcessProcessorEnablersByQuery(ProcessProcessorEnablerQuery processProcessorEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of ProcessProcessorEnablers matching the given search.
      Parameters:
      processProcessorEnablerQuery - the process processor enabler query
      Returns:
      the returned ProcessProcessorEnablerList
      Throws:
      NullArgumentException - processProcessorEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - processProcessorEnablerQuery did not originate from getProcessProcessorEnablerQuery()
      Compliance:
      mandatory - This method must be implemented.