org.osid.resource.demographic

Interface DemographicQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector

public interface DemographicQueryInspector
extends OsidRuleQueryInspector

This is the query inspector for examning demographic queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getBinIdTerms() Gets the bin Id query terms.
BinQueryInspector[]	getBinTerms() Gets the bin query terms.
DemographicQueryInspectorRecord	getDemographicQueryInspectorRecord(Type demographicRecordType) Gets the demographic query inspector record corresponding to the given Demographic record Type.
IdTerm[]	getExcludedDemographicIdTerms() Gets the excluded demographic Id query terms.
DemographicQueryInspector[]	getExcludedDemographicTerms() Gets the excluded demographic query terms.
IdTerm[]	getExcludedResourceIdTerms() Gets the excluded resource Id query terms.
ResourceQueryInspector[]	getExcludedResourceTerms() Gets the excluded resource query terms.
IdTerm[]	getIncludedDemographicIdTerms() Gets the included demographic Id query terms.
DemographicQueryInspector[]	getIncludedDemographicTerms() Gets the included demographic query terms.
IdTerm[]	getIncludedExclusiveDemographicIdTerms() Gets the exclsuive demographic Id query terms.
DemographicQueryInspector[]	getIncludedExclusiveDemographicTerms() Gets the exclsuive demographic query terms.
IdTerm[]	getIncludedIntersectingDemographicIdTerms() Gets the intersecting demographic Id query terms.
DemographicQueryInspector[]	getIncludedIntersectingDemographicTerms() Gets the intersecting demographic query terms.
IdTerm[]	getIncludedResourceIdTerms() Gets the included resource Id query terms.
ResourceQueryInspector[]	getIncludedResourceTerms() Gets the included resource query terms.
IdTerm[]	getResultingResourceIdTerms() Gets the resulting resource Id query terms.
BooleanTerm[]	getResultingResourceTerms() Gets the resulting resource query terms.

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Method Detail

getIncludedDemographicIdTerms

IdTerm[] getIncludedDemographicIdTerms()

Gets the included demographic Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIncludedDemographicTerms

DemographicQueryInspector[] getIncludedDemographicTerms()

Gets the included demographic query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIncludedIntersectingDemographicIdTerms

IdTerm[] getIncludedIntersectingDemographicIdTerms()

Gets the intersecting demographic Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIncludedIntersectingDemographicTerms

DemographicQueryInspector[] getIncludedIntersectingDemographicTerms()

Gets the intersecting demographic query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIncludedExclusiveDemographicIdTerms

IdTerm[] getIncludedExclusiveDemographicIdTerms()

Gets the exclsuive demographic Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIncludedExclusiveDemographicTerms

DemographicQueryInspector[] getIncludedExclusiveDemographicTerms()

Gets the exclsuive demographic query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getExcludedDemographicIdTerms

IdTerm[] getExcludedDemographicIdTerms()

Gets the excluded demographic Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getExcludedDemographicTerms

DemographicQueryInspector[] getExcludedDemographicTerms()

Gets the excluded demographic query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIncludedResourceIdTerms

IdTerm[] getIncludedResourceIdTerms()

Gets the included resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIncludedResourceTerms

ResourceQueryInspector[] getIncludedResourceTerms()

Gets the included resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getExcludedResourceIdTerms

IdTerm[] getExcludedResourceIdTerms()

Gets the excluded resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getExcludedResourceTerms

ResourceQueryInspector[] getExcludedResourceTerms()

Gets the excluded resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getResultingResourceIdTerms

IdTerm[] getResultingResourceIdTerms()

Gets the resulting resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getResultingResourceTerms

BooleanTerm[] getResultingResourceTerms()

Gets the resulting resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBinIdTerms

IdTerm[] getBinIdTerms()

Gets the bin Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBinTerms

BinQueryInspector[] getBinTerms()

Gets the bin query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDemographicQueryInspectorRecord

DemographicQueryInspectorRecord getDemographicQueryInspectorRecord(Type demographicRecordType)
                                                                   throws OperationFailedException

Gets the demographic query inspector record corresponding to the given Demographic record Type.

Parameters:

demographicRecordType - a demographic record type

Returns:

the demographic query inspector record

Throws:

NullArgumentException - demographicRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(demographicRecordType) is false

Compliance:

mandatory - This method must be implemented.