OSID Logo
OSID Specifications
resource demographic package
Version 3.1.0
Interfaceosid.resource.demographic.DemographicEnablerSearchSession
Implementsosid.resource.demographic.DemographicEnablerQuerySession
Used Byosid.resource.demographic.ResourceDemographicManager
osid.resource.demographic.ResourceDemographicProxyManager
Description

This session provides methods for searching among DemographicEnablers. 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.
MethodgetDemographicEnablerSearch
Description

Gets a demographic enabler search.

Returnosid.resource.demographic.DemographicEnablerSearch the demographic enabler search
Compliancemandatory This method must be implemented.
MethodgetDemographicEnablerSearchOrder
Description

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

Returnosid.resource.demographic.DemographicEnablerSearchOrder the demographic enabler search order
Compliancemandatory This method must be implemented.
MethodgetDemographicEnablersBySearch
Description

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

Parametersosid.resource.demographic.DemographicEnablerQuerydemographicEnablerQuery the demographic enabler query
osid.resource.demographic.DemographicEnablerSearchdemographicEnablerSearch the demographic enabler search
Returnosid.resource.demographic.DemographicEnablerSearchResults the returned search results
ErrorsNULL_ARGUMENT demographicEnablerQuery or demographicEnablerSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED demographicEnablerQuery or demographicEnablerSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetDemographicEnablerQueryFromInspector
Description

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

Parametersosid.resource.demographic.DemographicEnablerQueryInspectordemographicEnablerQueryInspector a demographic enabler query inspector
Returnosid.resource.demographic.DemographicEnablerQuery the demographic enabler query
ErrorsNULL_ARGUMENT demographicEnablerQueryInspector is null
UNSUPPORTED demographicEnablerQueryInspector is not of this service
Compliancemandatory This method must be implemented.