Interface DemographicEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
DemographicEnablerSearchSession
public interface DemographicEnablerQuerySession extends OsidSession

This session provides methods for searching among DemographicEnablers . The search query is constructed using the DemographicEnablerQuery .

This session defines views that offer differing behaviors for searching.

  • federated bin view: searches include demographic enablers in bins of which this bin is an ancestor in the bin hierarchy
  • isolated bin view: searches are restricted to demographic enablers in this bin

Demographic enablers may have a query record indicated by their respective record types. The query record is accessed via the 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.

    • canSearchDemographicEnablers

      boolean canSearchDemographicEnablers()
      Tests if this user can perform DemographicEnabler 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 not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedBinView

      void useFederatedBinView()
      Federates the view for methods in this session. A federated view will include demographic enablers in bins which are children of this broker in the bin hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedBinView

      void useIsolatedBinView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this bin only.
      Compliance:
      mandatory - This method is must be implemented.

    • getDemographicEnablerQuery

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

    • getDemographicEnablersByQuery

      DemographicEnablerList getDemographicEnablersByQuery(DemographicEnablerQuery demographicEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of DemographicEnablers matching the given demographic enabler query.
      Parameters:
      demographicEnablerQuery - the demographic enabler query
      Returns:
      the returned DemographicEnablerList
      Throws:
      NullArgumentException - demographicEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - demographicEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.