Interface StepProcessorRuleLookupSession

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

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

    • canLookupStepProcessorRules

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

    • useComparativeStepProcessorRuleView

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

    • usePlenaryStepProcessorRuleView

      void usePlenaryStepProcessorRuleView()
      A complete view of the StepProcessor 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 processor 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.

    • getStepProcessorIdsForStep

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

    • getStepProcessorsForStep

      StepProcessorList getStepProcessorsForStep(Id stepId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the StepProcessor associated with a Step .
      Parameters:
      stepId - Id of the Auction
      Returns:
      the step processors
      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.

    • getStepIdsForStepProcessor

      IdList getStepIdsForStepProcessor(Id stepProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Step Ids mapped to a StepProcessor .
      Parameters:
      stepProcessorId - Id of a StepProcessor
      Returns:
      list of step 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.

    • getStepsForStepProcessor

      StepList getStepsForStepProcessor(Id stepProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Steps mapped to a StepProcessor .
      Parameters:
      stepProcessorId - Id of a StepProcessor
      Returns:
      list of steps
      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.