Interface ProcessProcessorRuleLookupSession

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

This session provides methods to retrieve ProcessProcessor to Process mappings.

Th is 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 office view: All methods in this session operate, retrieve and pertain to process processoras defined explicitly in the current office
  • federated office view: All 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.

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

    • canLookupProcessProcessorRules

      boolean canLookupProcessProcessorRules()
      Tests if this user can perform lookups of process processor/process 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.

    • useComparativeProcessProcessorRuleView

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

    • usePlenaryProcessProcessorRuleView

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

    • getProcessProcessorIdsForProcess

      IdList getProcessProcessorIdsForProcess(Id processId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProcessProcessor Ids associated with a Process .
      Parameters:
      processId - Id of the Process
      Returns:
      the process processor Ids
      Throws:
      NotFoundException - processId is not found
      NullArgumentException - processId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProcessProcessorsForProcess

      ProcessProcessorList getProcessProcessorsForProcess(Id processId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProcessProcessors associated with a Process .
      Parameters:
      processId - Id of the Process
      Returns:
      the process processors
      Throws:
      NotFoundException - processId is not found
      NullArgumentException - processId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProcessIdsForProcessProcessor

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

    • getProcessesForProcessProcessor

      ProcessList getProcessesForProcessProcessor(Id processProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Processes mapped to a ProcessProcessor .
      Parameters:
      processProcessorId - Id of a ProcessProcessor
      Returns:
      list of processes
      Throws:
      NotFoundException - processProcessorId is not found
      NullArgumentException - processProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.