Interface StepConstrainerEnablerLookupSession

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

This session provides methods for retrieving StepConstrainerEnablers .

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

    • canLookupStepConstrainerEnablers

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

    • useComparativeStepConstrainerEnablerView

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

    • usePlenaryStepConstrainerEnablerView

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

    • useActiveStepConstrainerEnablerView

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

    • useAnyStatusStepConstrainerEnablerView

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

    • getStepConstrainerEnabler

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

    • getStepConstrainerEnablersByIds

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

    • getStepConstrainerEnablersByGenusType

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

    • getStepConstrainerEnablersByParentGenusType

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

    • getStepConstrainerEnablersByRecordType

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

    • getStepConstrainerEnablersOnDate

      StepConstrainerEnablerList getStepConstrainerEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a StepConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known step constrainer enablers or an error results. Otherwise, the returned list may contain only those step constrainer enablers that are accessible through this session. In active mode, step constrainer enablers are returned that are currently active. In any status mode, active and inactive step constrainer enablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned StepConstrainerEnabler list
      Throws:
      InvalidArgumentException - from is greater tha to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getStepConstrainerEnablersOnDateWithAgent

      StepConstrainerEnablerList getStepConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a StepConstrainerEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known step constrainer enablers or an error results. Otherwise, the returned list may contain only those step constrainer enablers that are accessible through this session. In active mode, step constrainer enablers are returned that are currently active. In any status mode, active and inactive step constrainer enablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned StepConstrainerEnabler list
      Throws:
      InvalidArgumentException - from is greater tha to
      NullArgumentException - agentId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getStepConstrainerEnablers

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