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

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

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

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

MethodgetBinId
Description

Gets the Bin Id associated with this session.

Returnosid.id.Idthe Bin Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBin
Description

Gets the Bin associated with this session.

Returnosid.resource.Binthe bin
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchDemographics
Description

Tests if this user can perform Demographic 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.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedBinView
Description

Federates the view for methods in this session. A federated view will include demographic in bins which are children of this broker in the bin hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBinView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this bin only.

CompliancemandatoryThis method is must be implemented.
MethodgetDemographicQuery
Description

Gets a demographic query.

Returnosid.resource.demographic.DemographicQuerythe demographic query
CompliancemandatoryThis method must be implemented.
MethodgetDemographicsByQuery
Description

Gets a list of Demographics matching the given demographic query.

Parametersosid.resource.demographic.DemographicQuerydemographicQuerythe demographic query
Returnosid.resource.demographic.DemographicListthe returned DemographicList
ErrorsNULL_ARGUMENT demographicQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED demographicQuery is not of this service
CompliancemandatoryThis method must be implemented.