| Interface | osid.resource.demographic.DemographicEnablerQuerySession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Demographic enablers 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 | canSearchDemographicEnablers | ||
| 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 enablers 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 | getDemographicEnablerQuery | ||
| Description |
Gets a demographic enabler query. | ||
| Return | osid.resource.demographic.DemographicEnablerQuery | the demographic enabler query | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDemographicEnablersByQuery | ||
| Description |
Gets a list of | ||
| Parameters | osid.resource.demographic.DemographicEnablerQuery | demographicEnablerQuery | the demographic enabler query |
| Return | osid.resource.demographic.DemographicEnablerList | the returned DemographicEnablerList | |
| Errors | NULL_ARGUMENT | demographicEnablerQuery is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | demographicEnablerQuery is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |