Interface JobProcessorEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
JobProcessorEnablerSearchSession
public interface JobProcessorEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

Like all OsidSessions, JobProcessorEnablerQuerySessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getFoundryId

      Id getFoundryId()
      Gets the Foundry Id associated with this session.
      Returns:
      the Foundry Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getFoundry

      Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
      Gets the Foundry associated with this session.
      Returns:
      the foundry
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchJobProcessorEnablers

      boolean canSearchJobProcessorEnablers()
      Tests if this user can perform JobProcessorEnabler 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.

    • useFederatedFoundryView

      void useFederatedFoundryView()
      Federates the view for methods in this session. A federated view will include job processor enablers in foundries which are children of this job in the foundry hierarchy.
      Compliance:
      mandatory - This method must be implemented.

    • useIsolatedFoundryView

      void useIsolatedFoundryView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this foundry only.
      Compliance:
      mandatory - This method must be implemented.

    • getJobProcessorEnablerQuery

      JobProcessorEnablerQuery getJobProcessorEnablerQuery()
      Gets a job processor enabler query.
      Returns:
      the job processor enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getJobProcessorEnablersByQuery

      JobProcessorEnablerList getJobProcessorEnablersByQuery(JobProcessorEnablerQuery jobProcessorEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of JobProcessorEnablers matching the given job processor enabler query.
      Parameters:
      jobProcessorEnablerQuery - the job processor enabler query
      Returns:
      the returned JobProcessorEnablerList
      Throws:
      NullArgumentException - jobProcessorEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - jobProcessorEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.