Interface | osid.resource.demographic.DemographicQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Demographic may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getBinId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Bin Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBin | ||
Description |
Gets the | ||
Return | osid.resource.Bin | the bin | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchDemographics | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedBinView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedBinView | ||
Description |
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. | |
Method | getDemographicQuery | ||
Description |
Gets a demographic query. | ||
Return | osid.resource.demographic.DemographicQuery | the demographic query | |
Compliance | mandatory | This method must be implemented. | |
Method | getDemographicsByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.resource.demographic.DemographicQuery | demographicQuery | the demographic query |
Return | osid.resource.demographic.DemographicList | the returned DemographicList | |
Errors | NULL_ARGUMENT | demographicQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | demographicQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |