Interface ProcessEnablerRuleLookupSession

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

This session provides methods to retrieve ProcessEnabler to Process mappings. A Process with multiple ProcessEnablers means any positive rule evaluation across the constrainers result in an accessible Process .

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

    • canLookupProcessEnablerRules

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

    • useComparativeProcessEnablerRuleView

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

    • usePlenaryProcessEnablerRuleView

      void usePlenaryProcessEnablerRuleView()
      A complete view of the ProcessEnabler 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 enabler 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.

    • getProcessEnablerIdsForProcess

      IdList getProcessEnablerIdsForProcess(Id processId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProcessEnabler Id associated with a Process .
      Parameters:
      processId - Id of the Process
      Returns:
      the process enabler 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.

    • getProcessEnablersForProcess

      ProcessEnablerList getProcessEnablersForProcess(Id processId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProcessEnabler associated with a Process .
      Parameters:
      processId - Id of the Process
      Returns:
      the process enablers
      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.

    • getProcessIdsForProcessEnabler

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

    • getProcesssForProcessEnabler

      ProcessList getProcesssForProcessEnabler(Id processEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Processs mapped to a ProcessEnabler .
      Parameters:
      processEnablerId - Id of a ProcessEnabler
      Returns:
      list of processs
      Throws:
      NotFoundException - processEnablerId is not found
      NullArgumentException - processEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.