Interface ProcessProcessorLookupSession

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

This session provides methods for retrieving ProcessProcessors .

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 office view: All process processor methods in this session operate, retrieve and pertain to process processors defined explicitly in the current office Using an isolated view is useful for managing ProcessProcessors with the ProcessProcessorAdminSession .
  • federated office view: All process processor methods in this session operate, retrieve and pertain to all process processors defined in this office and any other process processors implicitly available in this office through office inheritence.

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 useFederatedOfficeView() and useIsolatedOfficeView() behave as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getOfficeId

      Id getOfficeId()
      Gets the Office Id associated with this session.
      Returns:
      the Office Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getOffice

      Office getOffice() throws OperationFailedException, PermissionDeniedException
      Gets the Office associated with this session.
      Returns:
      the office
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupProcessProcessors

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

    • useComparativeProcessProcessorView

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

    • usePlenaryProcessProcessorView

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

    • useFederatedOfficeView

      void useFederatedOfficeView()
      Federates the view for methods in this session. A federated view will include process processors in offices which are children of this office in the office hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedOfficeView

      void useIsolatedOfficeView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this office only.
      Compliance:
      mandatory - This method is must be implemented.

    • getProcessProcessor

      ProcessProcessor getProcessProcessor(Id processProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProcessProcessor specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned ProcessProcessor may have a different Id than requested, such as the case where a duplicate Id was assigned to a ProcessProcessor and re tained for compatibility.
      Parameters:
      processProcessorId - Id of the ProcessProcessor
      Returns:
      the process processor
      Throws:
      NotFoundException - processProcessorId not found
      NullArgumentException - processProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getProcessProcessorsByIds

      ProcessProcessorList getProcessProcessorsByIds(IdList processProcessorIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a ProcessProcessorList corresponding to the given IdList . In plenary mode, the returned list contains all of the process processors 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 ProcessProcessors may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      processProcessorIds - the list of Ids to retrieve
      Returns:
      the returned ProcessProcessor list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - processProcessorIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessorsByGenusType

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

    • getProcessProcessorsByParentGenusType

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

    • getProcessProcessorsByRecordType

      ProcessProcessorList getProcessProcessorsByRecordType(Type processProcessorRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a ProcessProcessorList containing the given process processor record Type . In plenary mode, the returned list contains all known process processors or an error results. Otherwise, the returned list may contain only those process processors that are accessible through this session.
      Parameters:
      processProcessorRecordType - a process processor record type
      Returns:
      the returned ProcessProcessor list
      Throws:
      NullArgumentException - processProcessorRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessors

      ProcessProcessorList getProcessProcessors() throws OperationFailedException, PermissionDeniedException
      Gets all ProcessProcessors . In plenary mode, the returned list contains all known process processors or an error results. Otherwise, the returned list may contain only those process processors that are accessible through this session.
      Returns:
      a list of ProcessProcessors
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.