Interface StepLookupSession

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

This session provides methods for retrieving Steps . The Step represents a fixed connection between two Availabilities .

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated office view: All step methods in this session operate, retrieve and pertain to steps defined explicitly in the current office. Using an isolated view is useful for managing Steps with the StepAdminSession .
  • federated office view: All step methods in this session operate, retrieve and pertain to all steps defined in this office and any other steps implicitly available in this office through office inheritence.
  • active step view: active steps are returned from methods in this session
  • any status step view: active and inactive steps are returned from methods in this session

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedOfficeView() and useIsolatedOfficeView() behave as a radio group and one should be selected before invoking any lookup methods.

  • 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.

    • canLookupSteps

      boolean canLookupSteps()
      Tests if this user can perform Step lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeStepView

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

    • usePlenaryStepView

      void usePlenaryStepView()
      A complete view of the 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 steps 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.

    • useActiveStepView

      void useActiveStepView()
      Only active steps are returned from methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusStepView

      void useAnyStatusStepView()
      Borth active and inactive steps are returned from methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getStep

      Step getStep(Id stepId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Step specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Step may have a different Id than requested, such as the case where a duplicate Id was assigned to a Step and retained for compatibility. In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.
      Parameters:
      stepId - Id of the Step
      Returns:
      the step
      Throws:
      NotFoundException - stepId not found
      NullArgumentException - stepId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getStepsByIds

      StepList getStepsByIds(IdList stepIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a StepList corresponding to the given IdList . In plenary mode, the returned list contains all of the steps specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Steps may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.
      Parameters:
      stepIds - the list of Ids to retrieve
      Returns:
      the returned Step list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - stepIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getStepsByGenusType

      StepList getStepsByGenusType(Type stepGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a StepList corresponding to the given step genus Type which does not include steps of genus types derived from the specified Type . In plenary mode, the returned list contains all known steps or an error results. Otherwise, the returned list may contain only those steps that are accessible through this session. In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.
      Parameters:
      stepGenusType - a step genus type
      Returns:
      the returned Step list
      Throws:
      NullArgumentException - stepGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getStepsByParentGenusType

      StepList getStepsByParentGenusType(Type stepGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a StepList corresponding to the given step genus Type and include any additional steps with genus types derived from the specified Type . In plenary mode, the returned list contains all known steps or an error results. Otherwise, the returned list may contain only those steps that are accessible through this session. In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.
      Parameters:
      stepGenusType - a step genus type
      Returns:
      the returned Step list
      Throws:
      NullArgumentException - stepGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getStepsByRecordType

      StepList getStepsByRecordType(Type stepRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a StepList containing the given step record Type . In plenary mode, the returned list contains all known steps or an error results. Otherwise, the returned list may contain only those steps that are accessible through this session. In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.
      Parameters:
      stepRecordType - a step record type
      Returns:
      the returned Step list
      Throws:
      NullArgumentException - stepRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getStepsForProcess

      StepList getStepsForProcess(Id processId) throws OperationFailedException, PermissionDeniedException
      Gets a list of steps by process. In plenary mode, the returned list contains all known steps or an error results. Otherwise, the returned list may contain only those steps that are accessible through this session. In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.
      Parameters:
      processId - a process Id
      Returns:
      the returned Step list
      Throws:
      NullArgumentException - processId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getStepsByState

      StepList getStepsByState(Id stateId) throws OperationFailedException, PermissionDeniedException
      Gets a list of steps for which the given state is valid. The steps returned are the states specified in the previous step or the process. In plenary mode, the returned list contains all known steps or an error results. Otherwise, the returned list may contain only those steps that are accessible through this session. In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.
      Parameters:
      stateId - a stateId Id
      Returns:
      the returned Step list
      Throws:
      NullArgumentException - stateId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSteps

      StepList getSteps() throws OperationFailedException, PermissionDeniedException
      Gets all Steps . In plenary mode, the returned list contains all known steps or an error results. Otherwise, the returned list may contain only those steps that are accessible through this session. In active mode, steps are returned that are currently active. In any status mode, active and inactive steps are returned.
      Returns:
      a list of Steps
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.