OSID Logo
OSID Specifications
resource demographic package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.demographic.DemographicSearchSession
Implementsosid.resource.demographic.DemographicQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetDemographicSearch
Description

Gets a demographic search.

Returnosid.resource.demographic.DemographicSearchthe demographic search
CompliancemandatoryThis method must be implemented.
MethodgetDemographicSearchOrder
Description

Gets a demographic search order. The DemographicSearchOrder is supplied to a DemographicSearch to specify the ordering of results.

Returnosid.resource.demographic.DemographicSearchOrderthe demographic search order
CompliancemandatoryThis method must be implemented.
MethodgetDemographicsBySearch
Description

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

Parametersosid.resource.demographic.DemographicQuerydemographicQuerythe demographic query
osid.resource.demographic.DemographicSearchdemographicSearchthe demographic search
Returnosid.resource.demographic.DemographicSearchResultsthe returned search results
ErrorsNULL_ARGUMENT demographicQuery or demographicSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED demographicQuery or demographicSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDemographicQueryFromInspector
Description

Gets a demographic query from an inspector. The inspector is available from a DemographicSearchResults.

Parametersosid.resource.demographic.DemographicQueryInspectordemographicQueryInspectora demographic query inspector
Returnosid.resource.demographic.DemographicQuerythe demographic query
ErrorsNULL_ARGUMENT demographicQueryInspector is null
UNSUPPORTED demographicQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.