Interface JobProcessorLookupSession

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

This session provides methods for retrieving JobProcessors .

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 processor methods in this session operate, retrieve and pertain to job processor defined explicitly in the current foundry. Using an isolated view is useful for managing JobProcessors with the JobProcessorAdminSession .
  • federated foundry view: All job processor methods in this session operate, retrieve and pertain to all job processor defined in this foundry and any other job processor implicitly available in this foundry through foundry inheritence.
  • active job processor view: All job processor lookup methods return active job processors.
  • any status job processor view: Job processors 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 the methods in this session.

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

    • canLookupJobProcessors

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

    • useComparativeJobProcessorView

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

    • usePlenaryJobProcessorView

      void usePlenaryJobProcessorView()
      A complete view of the JobProcessor 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 processor 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.

    • useActiveJobProcessorView

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

    • useAnyStatusJobProcessorView

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

    • getJobProcessor

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

    • getJobProcessorsByIds

      JobProcessorList getJobProcessorsByIds(IdList jobProcessorIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a JobProcessorList corresponding to the given IdList . In plenary mode, the returned list contains all of the job processor 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 JobProcessors may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, job processors are returned that are currently active. In any status mode, active and inactive job processors are returned.
      Parameters:
      jobProcessorIds - the list of Ids to retrieve
      Returns:
      the returned JobProcessor list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - jobProcessorIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJobProcessorsByGenusType

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

    • getJobProcessorsByParentGenusType

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

    • getJobProcessorsByRecordType

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

    • getJobProcessors

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