Interface StepEnablerRuleLookupSession

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

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

    • canLookupStepEnablerRules

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

    • useComparativeStepEnablerRuleView

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

    • usePlenaryStepEnablerRuleView

      void usePlenaryStepEnablerRuleView()
      A complete view of the StepEnabler and Step 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 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.

    • getStepEnablerIdsForStep

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

    • getStepEnablersForStep

      StepEnablerList getStepEnablersForStep(Id stepId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the StepEnablers associated with a Step .
      Parameters:
      stepId - Id of the Step
      Returns:
      the step enablers
      Throws:
      NotFoundException - stepId is not found
      NullArgumentException - stepId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getStepIdsForStepEnabler

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

    • getStepsForStepEnabler

      StepList getStepsForStepEnabler(Id stepEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Steps mapped to a StepEnabler .
      Parameters:
      stepEnablerId - Id of a StepEnabler
      Returns:
      list of steps
      Throws:
      NotFoundException - stepEnablerId is not found
      NullArgumentException - stepEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.