Interface StepConstrainerRuleLookupSession

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

This session provides methods to retrieve StepConstrainer to Step mappings. A Step with multiple StepConstrainers means any positive rule evaluation across the constrainers result in an accessible Step .

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

    • canLookupStepConstrainerRules

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

    • useComparativeStepConstrainerRuleView

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

    • usePlenaryStepConstrainerRuleView

      void usePlenaryStepConstrainerRuleView()
      A complete view of the StepConstrainer 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 constrainer 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.

    • getStepConstrainerIdsForStep

      IdList getStepConstrainerIdsForStep(Id stepId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the StepConstrainer Id associated with a Step .
      Parameters:
      stepId - Id of the Step
      Returns:
      the step constrainer 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.

    • getStepConstrainersForStep

      StepConstrainerList getStepConstrainersForStep(Id stepId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the StepConstrainer associated with a Step .
      Parameters:
      stepId - Id of the Step
      Returns:
      the step constrainers
      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.

    • getStepIdsForStepConstrainer

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

    • getStepsForStepConstrainer

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