Interface StepEnablerLookupSession

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

This session provides methods for retrieving StepEnablers .

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 enabler methods in this session operate, retrieve and pertain to step enablers defined explicitly in the current office Using an isolated view is useful for managing StepEnablers with the StepEnablerAdminSession .
  • federated office view: All step enabler methods in this session operate, retrieve and pertain to all step enablers defined in this office and any other step enablers implicitly available in this office through office inheritence.

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.

    • canLookupStepEnablers

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

    • useComparativeStepEnablerView

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

    • usePlenaryStepEnablerView

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

    • getStepEnabler

      StepEnabler getStepEnabler(Id stepEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the StepEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned StepEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a StepEnabler and retai ned for compatibility.
      Parameters:
      stepEnablerId - Id of the StepEnabler
      Returns:
      the step enabler
      Throws:
      NotFoundException - stepEnablerId not found
      NullArgumentException - stepEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getStepEnablersByIds

      StepEnablerList getStepEnablersByIds(IdList stepEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a StepEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the step enablers 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 StepEnablers may be omi tted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      stepEnablerIds - the list of Ids to retrieve
      Returns:
      the returned StepEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - stepEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getStepEnablersByGenusType

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

    • getStepEnablersByParentGenusType

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

    • getStepEnablersByRecordType

      StepEnablerList getStepEnablersByRecordType(Type stepEnablerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a StepEnablerList containing the given step enabler record Type . In plenary mode, the returned list contains all known step enablers or an error results. Otherwise, the returned list may contain only those step enablers that are accessible through this session.
      Parameters:
      stepEnablerRecordType - a step enabler record type
      Returns:
      the returned StepEnabler list
      Throws:
      NullArgumentException - stepEnablerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getStepEnablers

      StepEnablerList getStepEnablers() throws OperationFailedException, PermissionDeniedException
      Gets all StepEnablers . In plenary mode, the returned list contains all known step enablers or an error results. Otherwise, the returned list may contain only those step enablers that are accessible through this session.
      Returns:
      a list of StepEnablers
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.