Interface ProcessConstrainerEnablerRuleLookupSession

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

This session provides methods to retrieve ProcessConstrainerEnabler to ProcessConstrainer mappings.

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

    • canLookupProcessConstrainerEnablerRules

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

    • useComparativeProcessConstrainerEnablerRuleView

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

    • usePlenaryProcessConstrainerEnablerRuleView

      void usePlenaryProcessConstrainerEnablerRuleView()
      A complete view of the ProcessConstrainerEnabler and ProcessConstrainer 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 constrainer 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.

    • getProcessConstrainerEnablerIdsForProcess

      IdList getProcessConstrainerEnablerIdsForProcess(Id processConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProcessConstrainerEnablerIds associated with a ProcessConstrainer .
      Parameters:
      processConstrainerId - Id of the ProcessConstrainer
      Returns:
      the process constrainer enabler Ids
      Throws:
      NotFoundException - processConstrainerId is not found
      NullArgumentException - processConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProcessConstrainerEnablersForProcessConstrainer

      ProcessConstrainerEnablerList getProcessConstrainerEnablersForProcessConstrainer(Id processConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProcessConstrainerEnablers associated with a ProcessConstrainer .
      Parameters:
      processConstrainerId - Id of the ProcessConstrainer
      Returns:
      the process constrainer enablers
      Throws:
      NotFoundException - processConstrainerId is not found
      NullArgumentException - processConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProcessConstrainerIdsForProcessConstrainerEnabler

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

    • getProcessConstrainersForProcessConstrainerEnabler

      ProcessConstrainerList getProcessConstrainersForProcessConstrainerEnabler(Id processConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProcessConstrainers mapped to a ProcessConstrainerEnabler .
      Parameters:
      processConstrainerEnablerId - Id of a ProcessConstrainerEnabler
      Returns:
      list of process constrainers
      Throws:
      NotFoundException - processConstrainerEnablerId is not found
      NullArgumentException - processConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.