Interface JobConstrainerRuleLookupSession

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

This session provides methods to retrieve JobConstrainer to Job mappings. A Job with multiple JobConstrainers means any positive rule evaluation across the result in an effective Job .

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated foundry view: All methods in this session operate, retrieve and pertain job constrainer defined explicitly in the current foundry
  • federated foundry view: All methods in this session operate, retrieve and pertain to all job constrainer defined in this foundry and any other job constrainer implicitly available in this foundry through foundry inheritence.

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

    • canLookupJobConstrainerRules

      boolean canLookupJobConstrainerRules()
      Tests if this user can perform lookups of job constrainer/job mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeJobConstrainerRuleView

      void useComparativeJobConstrainerRuleView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryJobConstrainerRuleView

      void usePlenaryJobConstrainerRuleView()
      A complete view of the JobConstrainer and Job returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • useFederatedFoundryView

      void useFederatedFoundryView()
      Federates the view for methods in this session. A federated view will include job constrainer in foundries which are children of this foundry in the foundry hierarchy.
      Compliance:
      mandatory - This method is 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 is must be implemented.

    • getJobConstrainerIdsForJob

      IdList getJobConstrainerIdsForJob(Id jobId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the JobConstrainer Id associated with a Job .
      Parameters:
      jobId - Id of the Job
      Returns:
      the job constrainer Ids
      Throws:
      NotFoundException - jobId is not found
      NullArgumentException - jobId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJobConstrainersForJob

      JobConstrainerList getJobConstrainersForJob(Id jobId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the JobConstrainer associated with a Job .
      Parameters:
      jobId - Id of the Job
      Returns:
      the job constrainers
      Throws:
      NotFoundException - jobId is not found
      NullArgumentException - jobId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJobIdsForJobConstrainer

      IdList getJobIdsForJobConstrainer(Id jobConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Job Ids mapped to a JobConstrainer .
      Parameters:
      jobConstrainerId - Id of a JobConstrainer
      Returns:
      list of job Ids
      Throws:
      NotFoundException - jobConstrainerId is not found
      NullArgumentException - jobConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJobsForJobConstrainer

      JobList getJobsForJobConstrainer(Id jobConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Jobs mapped to a JobConstrainer .
      Parameters:
      jobConstrainerId - Id of a JobConstrainer
      Returns:
      list of jobs
      Throws:
      NotFoundException - jobConstrainerId is not found
      NullArgumentException - jobConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.