OSID Specifications
resource demographic package
Version 3.0.0
Release Candidate Preview
resource demographic package
Version 3.0.0
Release Candidate Preview
| Interface | osid.resource.demographic.DemographicQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRuleQueryInspector | ||
| Description |
This is the query inspector for examning demographic queries. | ||
| Method | getIncludedDemographicIdTerms | ||
| Description |
Gets the included demographic | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIncludedDemographicTerms | ||
| Description |
Gets the included demographic query terms. | ||
| Return | osid.resource.demographic.DemographicQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIncludedIntersectingDemographicIdTerms | ||
| Description |
Gets the intersecting demographic | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIncludedIntersectingDemographicTerms | ||
| Description |
Gets the intersecting demographic query terms. | ||
| Return | osid.resource.demographic.DemographicQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIncludedExclusiveDemographicIdTerms | ||
| Description |
Gets the exclsuive demographic | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIncludedExclusiveDemographicTerms | ||
| Description |
Gets the exclsuive demographic query terms. | ||
| Return | osid.resource.demographic.DemographicQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getExcludedDemographicIdTerms | ||
| Description |
Gets the excluded demographic | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getExcludedDemographicTerms | ||
| Description |
Gets the excluded demographic query terms. | ||
| Return | osid.resource.demographic.DemographicQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIncludedResourceIdTerms | ||
| Description |
Gets the included resource | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIncludedResourceTerms | ||
| Description |
Gets the included resource query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getExcludedResourceIdTerms | ||
| Description |
Gets the excluded resource | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getExcludedResourceTerms | ||
| Description |
Gets the excluded resource query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResultingResourceIdTerms | ||
| Description |
Gets the resulting resource | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResultingResourceTerms | ||
| Description |
Gets the resulting resource query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBinIdTerms | ||
| Description |
Gets the bin | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBinTerms | ||
| Description |
Gets the bin query terms. | ||
| Return | osid.resource.BinQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDemographicQueryInspectorRecord | ||
| Description |
Gets the demographic query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | demographicRecordType | a demographic record type |
| Return | osid.resource.demographic.records.DemographicQueryInspectorRecord | the demographic query inspector record | |
| Errors | NULL_ARGUMENT | demographicRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(demographicRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |