Interface ProcessProcessorEnablerRuleLookupSession

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

This session provides methods to retrieve ProcessProcessorEnabler to ProcessProcessor mapping s.

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 office view: All methods in this session operate, retrieve and pertain to process processor enablers defined explicitly in the current office
  • federated office view: All methods in this session operate, retrieve and pertain to all process processor enablers defined in this office and any other process processor enablers 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.

    • canLookupProcessProcessorEnablerRules

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

    • useComparativeProcessProcessorEnablerRuleView

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

    • usePlenaryProcessProcessorEnablerRuleView

      void usePlenaryProcessProcessorEnablerRuleView()
      A complete view of the ProcessProcessorEnabler and 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 processor enablers 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.

    • getProcessProcessorEnablerIdsForProcess

      IdList getProcessProcessorEnablerIdsForProcess(Id processProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProcessProcessorEnablerIds associated with a ProcessProcessor .
      Parameters:
      processProcessorId - Id of the ProcessProcessor
      Returns:
      the process processor enabler 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.

    • getProcessProcessorEnablersForProcessProcessor

      ProcessProcessorEnablerList getProcessProcessorEnablersForProcessProcessor(Id processProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProcessProcessorEnablers associated with a ProcessProcessor .
      Parameters:
      processProcessorId - Id of the ProcessProcessor
      Returns:
      the process processor enablers
      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.

    • getProcessProcessorIdsForProcessProcessorEnabler

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

    • getProcessProcessorsForProcessProcessorEnabler

      ProcessProcessorList getProcessProcessorsForProcessProcessorEnabler(Id processProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProcessProcessors mapped to a ProcessProcessorEnabler .
      Parameters:
      processProcessorEnablerId - Id of a ProcessprocessorEnabler
      Returns:
      list of process processors
      Throws:
      NotFoundException - processProcessorEnablerId is not found
      NullArgumentException - processProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.