Interface StepProcessorEnablerRuleLookupSession

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

This session provides methods to retrieve StepProcessorEnabler to StepProcessor mappings. a StepProcessor with multiple StepProcessorEnablers means any positive rule evaluation across the enablers result in an effective StepProcessor .

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

    • canLookupStepProcessorEnablerRules

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

    • useComparativeStepProcessorEnablerRuleView

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

    • usePlenaryStepProcessorEnablerRuleView

      void usePlenaryStepProcessorEnablerRuleView()
      A complete view of the StepProcessorEnabler and StepProcessor 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 step 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.

    • getStepProcessorEnablerIdsForStepProcessor

      IdList getStepProcessorEnablerIdsForStepProcessor(Id stepProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the StepProcessorEnabler Id associated with a StepProcessor .
      Parameters:
      stepProcessorId - Id of the StepProcessor
      Returns:
      the step processor enabler Ids
      Throws:
      NotFoundException - stepProcessorId is not found
      NullArgumentException - stepProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getStepProcessorEnablersForStepProcessor

      StepProcessorEnablerList getStepProcessorEnablersForStepProcessor(Id stepProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the StepProcessorEnabler associated with a StepProcessor .
      Parameters:
      stepProcessorId - Id of the StepProcessor
      Returns:
      the step processor enablers
      Throws:
      NotFoundException - stepProcessorId is not found
      NullArgumentException - stepProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getStepProcessorIdsForStepProcessorEnabler

      IdList getStepProcessorIdsForStepProcessorEnabler(Id stepProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the StepProcessor Ids mapped to a StepProcessorEnabler .
      Parameters:
      stepProcessorEnablerId - Id of a StepProcessorEnabler
      Returns:
      list of step processor Ids
      Throws:
      NotFoundException - stepProcessorEnablerId is not found
      NullArgumentException - stepProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getStepProcessorsForStepProcessorEnabler

      StepProcessorList getStepProcessorsForStepProcessorEnabler(Id stepProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the StepProcessors mapped to a StepProcessorEnabler .
      Parameters:
      stepProcessorEnablerId - Id of a StepProcessorEnabler
      Returns:
      list of step processors
      Throws:
      NotFoundException - stepProcessorEnablerId is not found
      NullArgumentException - stepProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.