Interface DemographicSmartBinSession

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

This session manages queries and sequencing to create "smart" dynamic bins. A DemographicQuery can be retrieved from this session and mapped to this Bin to create a virtual collection of demographics. The demographic may be sequenced using the DemographicSearchOrder from this session.

This Bin has a default query that matches any demographic and a default search order that specifies no sequencing. The queries may be examined using a DemographicQueryInspector . The query may be modified by converting the inspector back to a DemographicQuery .

  • Method Details

    • getBinId

      Id getBinId()
      Gets the Bin Id associated with this session.
      Returns:
      the Bin Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getBin

      Bin getBin() throws OperationFailedException, PermissionDeniedException
      Gets the Bin associated with this session.
      Returns:
      the bin
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartBins

      boolean canManageSmartBins()
      Tests if this user can manage smart bins. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
      Returns:
      false if smart bin management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getDemographicQuery

      DemographicQuery getDemographicQuery()
      Gets a demographic query.
      Returns:
      the demographic query
      Compliance:
      mandatory - This method must be implemented.

    • getDemographicSearchOrder

      DemographicSearchOrder getDemographicSearchOrder()
      Gets a demographic search order.
      Returns:
      the demographic search order
      Compliance:
      mandatory - This method must be implemented.

    • applyDemographicQuery

      void applyDemographicQuery(DemographicQuery demographicQuery) throws OperationFailedException, PermissionDeniedException
      Applies a demographic query to this bin.
      Parameters:
      demographicQuery - the demographic query
      Throws:
      NullArgumentException - demographicQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - demographicQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectDemographicQuery

      DemographicQueryInspector inspectDemographicQuery() throws OperationFailedException, PermissionDeniedException
      Gets a demographic query inspector for this bin.
      Returns:
      the demographic query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyDemographicSequencing

      void applyDemographicSequencing(DemographicSearchOrder demographicSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a demographic search order to this bin.
      Parameters:
      demographicSearchOrder - the demographic search order
      Throws:
      NullArgumentException - demographicSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - demographicSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getDemographicQueryFromInspector

      DemographicQuery getDemographicQueryFromInspector(DemographicQueryInspector demographicQueryInspector)
      Gets a demographic query from an inspector.
      Parameters:
      demographicQueryInspector - a demographic query inspector
      Returns:
      the demographic query
      Throws:
      NullArgumentException - demographicQueryInspector is null
      UnsupportedException - demographicQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.