Interface DemographicEnablerSmartBinSession

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

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

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

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

    • getDemographicEnablerQuery

      DemographicEnablerQuery getDemographicEnablerQuery()
      Gets a demographic enabler query.
      Returns:
      the demographic enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getDemographicEnablerSearchOrder

      DemographicEnablerSearchOrder getDemographicEnablerSearchOrder()
      Gets a demographic enabler search order.
      Returns:
      the demographic enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyDemographicEnablerQuery

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

    • inspectDemographicEnablerQuery

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

    • applyDemographicEnablerSequencing

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

    • getDemographicEnablerQueryFromInspector

      DemographicEnablerQuery getDemographicEnablerQueryFromInspector(DemographicEnablerQueryInspector demographicEnablerQueryInspector)
      Gets a demographic enabler query from an inspector.
      Parameters:
      demographicEnablerQueryInspector - a demographic enabler query inspector
      Returns:
      the demographic enabler query
      Throws:
      NullArgumentException - demographicEnablerQueryInspector is null
      UnsupportedException - demographicEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.