Interface JobProcessorSmartFoundrySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface JobProcessorSmartFoundrySession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic foundries. A JobProcessorQuery can be retrieved from this session and mapped to this Foundry to create a virtual collection of job processors. The job processor may be sequenced using the JobProcessorSearchOrder from this session.

This Foundry has a default query that matches any job processor and a default search order that specifies no sequencing. The queries may be examined using a JobProcessorQueryInspector . The query may be modified by converting the inspector back to a JobProcessorQuery .

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

    • canManageSmartFoundries

      boolean canManageSmartFoundries()
      Tests if this user can manage smart foundries. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
      Returns:
      false if smart foundry management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getJobProcessorQuery

      JobProcessorQuery getJobProcessorQuery()
      Gets a job processor query.
      Returns:
      the job processor query
      Compliance:
      mandatory - This method must be implemented.

    • getJobProcessorSearchOrder

      JobProcessorSearchOrder getJobProcessorSearchOrder()
      Gets a job processor search order.
      Returns:
      the job processor search order
      Compliance:
      mandatory - This method must be implemented.

    • applyJobProcessorQuery

      void applyJobProcessorQuery(JobProcessorQuery jobProcessorQuery) throws OperationFailedException, PermissionDeniedException
      Applies a job processor query to this foundry.
      Parameters:
      jobProcessorQuery - the job processor query
      Throws:
      NullArgumentException - jobProcessorQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - jobProcessorQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectJobProcessorQuery

      JobProcessorQueryInspector inspectJobProcessorQuery() throws OperationFailedException, PermissionDeniedException
      Gets a job processor query inspector for this foundry.
      Returns:
      the job processor query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyJobProcessorSequencing

      void applyJobProcessorSequencing(JobProcessorSearchOrder jobProcessorSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a job processor search order to this foundry.
      Parameters:
      jobProcessorSearchOrder - the job processor search order
      Throws:
      NullArgumentException - jobProcessorSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - jobProcessorSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getJobProcessorQueryFromInspector

      JobProcessorQuery getJobProcessorQueryFromInspector(JobProcessorQueryInspector jobProcessorQueryInspector)
      Gets a job processor query from an inspector.
      Parameters:
      jobProcessorQueryInspector - a job processor query inspector
      Returns:
      the job processor query
      Throws:
      NullArgumentException - jobProcessorQueryInspector is null
      UnsupportedException - jobProcessorQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.