Interface JobLookupSession

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

This session provides methods for retrieving Job objects.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated foundry view: All job methods in this session operate, retrieve and pertain to jobs defined explicitly in the current foundry. Using an isolated view is useful for managing Jobs with the JobAdminSession .
  • federated foundry view: All job methods in this session operate, retrieve and pertain to all jobs defined in this foundry and any other jobs implicitly available in this foundry through foundry inheritence.
  • active job view: All job lookup methods return active jobs.
  • any status job view: Jobs of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedFoundryView() and useIsolatedFoundryView() behave as a radio group and one should be selected before invoking any lookup methods.

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

    • canLookupJobs

      boolean canLookupJobs()
      Tests if this user can perform Job 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 opt not to offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeJobView

      void useComparativeJobView()
      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.

    • usePlenaryJobView

      void usePlenaryJobView()
      A complete view of the 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 jobs 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.

    • useActiveJobView

      void useActiveJobView()
      Only active jobs are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusJobView

      void useAnyStatusJobView()
      All active and inactive authorization enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getJob

      Job getJob(Id jobId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Job specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Job may have a different Id than requested, such as the case where a duplicate Id was assigned to a Job and retained for compatibility. In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned.
      Parameters:
      jobId - Id of the Job
      Returns:
      the job
      Throws:
      NotFoundException - jobId not found
      NullArgumentException - jobId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getJobsByIds

      JobList getJobsByIds(IdList jobIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a JobList corresponding to the given IdList . In plenary mode, the returned list contains all of the jobs specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Jobs may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned.
      Parameters:
      jobIds - the list of Ids to retrieve
      Returns:
      the returned Job list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - jobIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJobsByGenusType

      JobList getJobsByGenusType(Type jobGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a JobList corresponding to the given job genus Type which does not include jobs of genus types derived from the specified Type . In plenary mode, the returned list contains all known jobs or an error results. Otherwise, the returned list may contain only those jobs that are accessible through this session. In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned.
      Parameters:
      jobGenusType - a job genus type
      Returns:
      the returned Job list
      Throws:
      NullArgumentException - jobGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJobsByParentGenusType

      JobList getJobsByParentGenusType(Type jobGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a JobList corresponding to the given job genus Type and include any additional jobs with genus types derived from the specified Type . In plenary mode, the returned list contains all known jobs or an error results. Otherwise, the returned list may contain only those jobs that are accessible through this session. In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned.
      Parameters:
      jobGenusType - a job genus type
      Returns:
      the returned Job list
      Throws:
      NullArgumentException - jobGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJobsByRecordType

      JobList getJobsByRecordType(Type jobRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a JobList containing the given job record Type . In plenary mode, the returned list contains all known jobs or an error results. Otherwise, the returned list may contain only those jobs that are accessible through this session. In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned.
      Parameters:
      jobRecordType - a job record type
      Returns:
      the returned Job list
      Throws:
      NullArgumentException - jobRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJobsByEmployer

      JobList getJobsByEmployer(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a JobList from the given employer. In plenary mode, the returned list contains all known jobs or an error results. Otherwise, the returned list may contain only those jobs that are accessible through this session. In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Job list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJobs

      JobList getJobs() throws OperationFailedException, PermissionDeniedException
      Gets all Jobs . In plenary mode, the returned list contains all known jobs or an error results. Otherwise, the returned list may contain only those jobs that are accessible through this session. In active mode, jobs are returned that are currently active. In any status mode, active and inactive jobs are returned.
      Returns:
      a list of Jobs
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.