Interface JobConstrainerSmartFoundrySession

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

This session manages queries and sequencing to create "smart" dynamic foundries. A JobConstrainerQuery can be retrieved from this session and mapped to this Foundry to create a virtual collection of job constrainers. The job constrainer may be sequenced using the JobConstrainerSearchOrder from this session.

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

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

    • getJobConstrainerQuery

      JobConstrainerQuery getJobConstrainerQuery()
      Gets a job constrainer query.
      Returns:
      the job constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getJobConstrainerSearchOrder

      JobConstrainerSearchOrder getJobConstrainerSearchOrder()
      Gets a job constrainer search order.
      Returns:
      the job constrainer search order
      Compliance:
      mandatory - This method must be implemented.

    • applyJobConstrainerQuery

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

    • inspectJobConstrainerQuery

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

    • applyJobConstrainerSequencing

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

    • getJobConstrainerQueryFromInspector

      JobConstrainerQuery getJobConstrainerQueryFromInspector(JobConstrainerQueryInspector jobConstrainerQueryInspector)
      Gets a job constrainer query from an inspector.
      Parameters:
      jobConstrainerQueryInspector - a job constrainer query inspector
      Returns:
      the job constrainer query
      Throws:
      NullArgumentException - jobConstrainerQueryInspector is null
      UnsupportedException - jobConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.