org.osid.resource.demographic

Interface DemographicEnablerSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, DemographicEnablerQuerySession, OsidSession

public interface DemographicEnablerSearchSession
extends DemographicEnablerQuerySession

This session provides methods for searching among DemographicEnabler objects. The search query is constructed using the DemographicEnableryQuery.

getDemographicEnablersByQuery() is the basic search method and returns a list of DemographicEnablers. A more advanced search may be performed with getDemographicEnablersBySearch(). It accepts a DemographicEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as bin. getDemographicEnablersBySearch() returns a DemographicEnablerSearchResults that can be used to access the resulting DemographicEnablerList or be used to perform a search within the result set through DemographicEnablerSearch.

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

DemographicEnablers may have a query record indicated by their respective record types. The query record is accessed via the DemographicEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
DemographicEnablerQuery	getDemographicEnablerQueryFromInspector(DemographicEnablerQueryInspector demographicEnablerQueryInspector) Gets a demographic enabler query from an inspector.
DemographicEnablerSearchResults	getDemographicEnablersBySearch(DemographicEnablerQuery demographicEnablerQuery, DemographicEnablerSearch demographicEnablerSearch) Gets the search results matching the given search query using the given search.
DemographicEnablerSearch	getDemographicEnablerSearch() Gets a demographic enabler search.
DemographicEnablerSearchOrder	getDemographicEnablerSearchOrder() Gets a demographic enabler search order.

Methods inherited from interface org.osid.resource.demographic.DemographicEnablerQuerySession

canSearchDemographicEnablers, getBin, getBinId, getDemographicEnablerQuery, getDemographicEnablersByQuery, useFederatedBinView, useIsolatedBinView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getDemographicEnablerSearch

DemographicEnablerSearch getDemographicEnablerSearch()

Gets a demographic enabler search.

Returns:

the demographic enabler search

Compliance:

mandatory - This method must be implemented.

getDemographicEnablerSearchOrder

DemographicEnablerSearchOrder getDemographicEnablerSearchOrder()

Gets a demographic enabler search order. The DemographicEnablerSearchOrder is supplied to a DemographicEnablerSearch to specify the ordering of results.

Returns:

the demographic enabler search order

Compliance:

mandatory - This method must be implemented.

getDemographicEnablersBySearch

DemographicEnablerSearchResults getDemographicEnablersBySearch(DemographicEnablerQuery demographicEnablerQuery,
                                                             DemographicEnablerSearch demographicEnablerSearch)
                                                               throws OperationFailedException,
                                                                      PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

demographicEnablerQuery - the demographic enabler query

demographicEnablerSearch - the demographic enabler search

Returns:

the returned search results

Throws:

NullArgumentException - demographicEnablerQuery or demographicEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - demographicEnablerQuery or demographicEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getDemographicEnablerQueryFromInspector

DemographicEnablerQuery getDemographicEnablerQueryFromInspector(DemographicEnablerQueryInspector demographicEnablerQueryInspector)

Gets a demographic enabler query from an inspector. The inspector is available from a DemographicEnablerSearchResults.

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.