Interface StepConstrainerLookupSession

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

This session provides methods for retrieving StepConstrainers .

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 constrainer methods in this session operate, retrieve and pertain to step constrainer defined explicitly in the current office. Using an isolated view is useful for managing StepConstrainers with the StepConstrainerAdminSession .
  • federated office view: All step constrainer 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.
  • active step constrainer view: All step constrainer lookup methods return active step constrainers.
  • any status step constrainer view: Step constrainers 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.

    • canLookupStepConstrainers

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

    • useComparativeStepConstrainerView

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

    • usePlenaryStepConstrainerView

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

    • useActiveStepConstrainerView

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

    • useAnyStatusStepConstrainerView

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

    • getStepConstrainer

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

    • getStepConstrainersByIds

      StepConstrainerList getStepConstrainersByIds(IdList stepConstrainerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a StepConstrainerList corresponding to the given IdList . In plenary mode, the returned list contains all of the step constrainer 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 StepConstrainers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, step constrainers are returned that are currently active. In any status mode, active and inactive step constrainers are returned.
      Parameters:
      stepConstrainerIds - the list of Ids to retrieve
      Returns:
      the returned StepConstrainer list
      Throws:
      NotFoundException - a Id was not found
      NullArgumentException - stepConstrainerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getStepConstrainersByGenusType

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

    • getStepConstrainersByParentGenusType

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

    • getStepConstrainersByRecordType

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

    • getStepConstrainers

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