Interface StepProcessorLookupSession

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

This session provides methods for retrieving StepProcessors .

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 processor methods in this session operate, retrieve and pertain to step processor defined explicitly in the current office. Using an isolated view is useful for managing StepProcessors with the StepProcessorAdminSession .
  • federated office view: All step processor 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.
  • active step processor view: All step processor lookup methods return active step processors.
  • any status step processor view: Step processors of any active or inactive status are returned from methods.

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 the methods in this session.

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

    • canLookupStepProcessors

      boolean canLookupStepProcessors()
      Tests if this user can perform StepProcessors 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.

    • useComparativeStepProcessorView

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

    • usePlenaryStepProcessorView

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

    • useActiveStepProcessorView

      void useActiveStepProcessorView()
      Only active step processors are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusStepProcessorView

      void useAnyStatusStepProcessorView()
      All active and inactive step processors enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getStepProcessor

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

    • getStepProcessorsByIds

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

    • getStepProcessorsByGenusType

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

    • getStepProcessorsByParentGenusType

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

    • getStepProcessorsByRecordType

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

    • getStepProcessors

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