org.osid

Interface OsidOperableQueryInspector

All Superinterfaces:

OsidQueryInspector

All Known Subinterfaces:

ActionEnablerQueryInspector, ActionQueryInspector, ActivityUnitQueryInspector, AssessmentPartQueryInspector, AuctionConstrainerEnablerQueryInspector, AuctionConstrainerQueryInspector, AuctionProcessorEnablerQueryInspector, AuctionProcessorQueryInspector, AuctionQueryInspector, AuditEnablerQueryInspector, AuditQueryInspector, AuthorizationEnablerQueryInspector, AvailabilityEnablerQueryInspector, BallotConstrainerEnablerQueryInspector, BallotConstrainerQueryInspector, BallotQueryInspector, BranchQueryInspector, BrokerConstrainerEnablerQueryInspector, BrokerConstrainerQueryInspector, BrokerProcessorEnablerQueryInspector, BrokerProcessorQueryInspector, BrokerQueryInspector, CanonicalUnitEnablerQueryInspector, CanonicalUnitProcessorEnablerQueryInspector, CanonicalUnitProcessorQueryInspector, CanonicalUnitQueryInspector, CatalogEnablerQueryInspector, CheckQueryInspector, CommissionEnablerQueryInspector, CommitmentEnablerQueryInspector, CompositionEnablerQueryInspector, CompositionQueryInspector, ContactEnablerQueryInspector, ControllerQueryInspector, ConvocationQueryInspector, CourseQueryInspector, DemographicEnablerQueryInspector, DemographicQueryInspector, DeviceEnablerQueryInspector, DispatchQueryInspector, EdgeEnablerQueryInspector, FunctionQueryInspector, GradebookColumnSummaryQueryInspector, HoldEnablerQueryInspector, InputEnablerQueryInspector, InputQueryInspector, InquiryEnablerQueryInspector, InquiryQueryInspector, InstructionQueryInspector, JobConstrainerEnablerQueryInspector, JobConstrainerQueryInspector, JobProcessorEnablerQueryInspector, JobProcessorQueryInspector, JobQueryInspector, ModuleQueryInspector, ObstacleEnablerQueryInspector, ObstacleQueryInspector, OfferingConstrainerEnablerQueryInspector, OfferingConstrainerQueryInspector, OffsetEventEnablerQueryInspector, OffsetEventQueryInspector, OsidConstrainerQueryInspector, OsidEnablerQueryInspector, OsidGovernatorQueryInspector, OsidProcessorQueryInspector, OsidRuleQueryInspector, ParameterProcessorEnablerQueryInspector, ParameterProcessorQueryInspector, ParameterQueryInspector, PoolConstrainerEnablerQueryInspector, PoolConstrainerQueryInspector, PoolProcessorEnablerQueryInspector, PoolProcessorQueryInspector, PoolQueryInspector, PriceEnablerQueryInspector, PriceQueryInspector, ProcessEnablerQueryInspector, ProcessQueryInspector, ProfileEntryEnablerQueryInspector, ProgramQueryInspector, QueueConstrainerEnablerQueryInspector, QueueConstrainerEnablerQueryInspector, QueueConstrainerQueryInspector, QueueConstrainerQueryInspector, QueueProcessorEnablerQueryInspector, QueueProcessorEnablerQueryInspector, QueueProcessorQueryInspector, QueueProcessorQueryInspector, QueueQueryInspector, QueueQueryInspector, RaceConstrainerEnablerQueryInspector, RaceConstrainerQueryInspector, RaceProcessorEnablerQueryInspector, RaceProcessorQueryInspector, RaceQueryInspector, RecurringEventEnablerQueryInspector, RecurringEventQueryInspector, RelationshipEnablerQueryInspector, RelevancyEnablerQueryInspector, RequisiteQueryInspector, SequenceRuleEnablerQueryInspector, SequenceRuleQueryInspector, SignalEnablerQueryInspector, SignalQueryInspector, SpeedZoneEnablerQueryInspector, SpeedZoneQueryInspector, StepConstrainerEnablerQueryInspector, StepConstrainerQueryInspector, StepProcessorEnablerQueryInspector, StepProcessorQueryInspector, StepQueryInspector, SubscriptionEnablerQueryInspector, SupersedingEventEnablerQueryInspector, SupersedingEventQueryInspector, TodoProducerQueryInspector, TriggerEnablerQueryInspector, TriggerQueryInspector, ValueEnablerQueryInspector, ValueQueryInspector

public interface OsidOperableQueryInspector
extends OsidQueryInspector

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to an OsidQuery for reuse or modification in the search sessions.

Method Summary

Methods

Modifier and Type	Method and Description
BooleanTerm[]	getActiveTerms() Gets the active query terms.
BooleanTerm[]	getDisabledTerms() Gets the administratively disabled query terms.
BooleanTerm[]	getEnabledTerms() Gets the administratively enabled query terms.
BooleanTerm[]	getOperationalTerms() Gets the operational query terms.

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Method Detail

getActiveTerms

BooleanTerm[] getActiveTerms()

Gets the active query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getEnabledTerms

BooleanTerm[] getEnabledTerms()

Gets the administratively enabled query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDisabledTerms

BooleanTerm[] getDisabledTerms()

Gets the administratively disabled query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOperationalTerms

BooleanTerm[] getOperationalTerms()

Gets the operational query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.