Interface OsidOperableQuery

All Superinterfaces:

OsidQuery, Suppliable

All Known Subinterfaces:

ActionEnablerQuery, ActionQuery, ActivityUnitQuery, AgendaQuery, AssessmentPartQuery, AuctionConstrainerEnablerQuery, AuctionConstrainerQuery, AuctionProcessorEnablerQuery, AuctionProcessorQuery, AuctionQuery, AuditConstrainerEnablerQuery, AuditConstrainerQuery, AuditEnablerQuery, AuditProcessorEnablerQuery, AuditProcessorQuery, AuditQuery, AuthorizationEnablerQuery, AvailabilityEnablerQuery, BallotConstrainerEnablerQuery, BallotConstrainerQuery, BallotQuery, BidEnablerQuery, BranchQuery, BrokerConstrainerEnablerQuery, BrokerConstrainerQuery, BrokerEnablerQuery, BrokerProcessorEnablerQuery, BrokerProcessorQuery, BrokerQuery, CanonicalUnitEnablerQuery, CanonicalUnitProcessorEnablerQuery, CanonicalUnitProcessorQuery, CanonicalUnitQuery, CatalogEnablerQuery, CheckQuery, CommissionEnablerQuery, CommitmentEnablerQuery, CompositionEnablerQuery, CompositionQuery, ContactEnablerQuery, ControllerQuery, ConvocationQuery, CourseQuery, CourseRequirementQuery, DemographicEnablerQuery, DemographicQuery, DeviceEnablerQuery, DispatchConstrainerEnablerQuery, DispatchConstrainerQuery, DispatchEnablerQuery, DispatchProcessorEnablerQuery, DispatchProcessorQuery, DispatchQuery, EdgeEnablerQuery, FunctionQuery, HoldEnablerQuery, InputEnablerQuery, InputQuery, InquiryEnablerQuery, InquiryQuery, InstructionQuery, IssueConstrainerEnablerQuery, IssueConstrainerQuery, IssueEnablerQuery, IssueProcessorEnablerQuery, IssueProcessorQuery, IssueQuery, JobConstrainerEnablerQuery, JobConstrainerQuery, JobProcessorEnablerQuery, JobProcessorQuery, JobQuery, ObstacleEnablerQuery, ObstacleQuery, OfferingConstrainerEnablerQuery, OfferingConstrainerQuery, OffsetEventEnablerQuery, OffsetEventQuery, OsidConstrainerQuery, OsidEffectuatorQuery, OsidEnablerQuery, OsidGovernatorQuery, OsidOperatorQuery, OsidProcessorQuery, OsidRuleApplicatorQuery, OsidRuleQuery, ParameterProcessorEnablerQuery, ParameterProcessorQuery, ParameterQuery, PoolConstrainerEnablerQuery, PoolConstrainerQuery, PoolEnablerQuery, PoolProcessorEnablerQuery, PoolProcessorQuery, PoolQuery, PriceEnablerQuery, PriceQuery, ProcessConstrainerEnablerQuery, ProcessConstrainerQuery, ProcessEnablerQuery, ProcessProcessorEnablerQuery, ProcessProcessorQuery, ProcessQuery, ProfileEntryEnablerQuery, ProgramQuery, ProvisionableEnablerQuery, ProvisionEnablerQuery, QueueConstrainerEnablerQuery, QueueConstrainerEnablerQuery, QueueConstrainerQuery, QueueConstrainerQuery, QueueEnablerQuery, QueueEnablerQuery, QueueProcessorEnablerQuery, QueueProcessorEnablerQuery, QueueProcessorQuery, QueueProcessorQuery, QueueQuery, QueueQuery, RaceConstrainerEnablerQuery, RaceConstrainerQuery, RaceProcessorEnablerQuery, RaceProcessorQuery, RaceQuery, RecurringEventEnablerQuery, RecurringEventQuery, RelationshipEnablerQuery, RelevancyEnablerQuery, RequisiteQuery, RuleQuery, SequenceRuleEnablerQuery, SequenceRuleQuery, SignalEnablerQuery, SignalQuery, SpeedZoneEnablerQuery, SpeedZoneQuery, StepConstrainerEnablerQuery, StepConstrainerQuery, StepEnablerQuery, StepProcessorEnablerQuery, StepProcessorQuery, StepQuery, SubscriptionEnablerQuery, SupersedingEventEnablerQuery, SupersedingEventQuery, TodoProducerQuery, TriggerEnablerQuery, TriggerQuery, ValueEnablerQuery, ValueQuery, VoteEnablerQuery

public interface OsidOperableQuery
extends OsidQuery

This is the query interface for searching operables. Each method specifies an AND term while multiple invocations of the same method produce a nested OR .

Method Summary

Modifier and Type	Method	Description
void	clearActiveTerms()	Clears the active query terms.
void	clearDisabledTerms()	Clears the administratively disabled query terms.
void	clearEnabledTerms()	Clears the administratively enabled query terms.
void	clearOperationalTerms()	Clears the operational query terms.
void	matchActive(boolean match)	Matches active.
void	matchDisabled(boolean match)	Matches administratively disabled.
void	matchEnabled(boolean match)	Matches administratively enabled.
void	matchOperational(boolean match)	Matches operational operables.

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

matchActive

void matchActive(boolean match)

Matches active.

Parameters:

match - true to match active, false to match inactive

Compliance:

mandatory - This method must be implemented.

clearActiveTerms

void clearActiveTerms()

Clears the active query terms.

Compliance:

mandatory - This method must be implemented.

matchEnabled

void matchEnabled(boolean match)

Matches administratively enabled.

Parameters:

match - true to match administratively enabled, false otherwise

Compliance:

mandatory - This method must be implemented.

clearEnabledTerms

void clearEnabledTerms()

Clears the administratively enabled query terms.

Compliance:

mandatory - This method must be implemented.

matchDisabled

void matchDisabled(boolean match)

Matches administratively disabled.

Parameters:

match - true to match administratively disabled, false otherwise

Compliance:

mandatory - This method must be implemented.

clearDisabledTerms

void clearDisabledTerms()

Clears the administratively disabled query terms.

Compliance:

mandatory - This method must be implemented.

matchOperational

void matchOperational(boolean match)

Matches operational operables.

Parameters:

match - true to match operational, false to match not operational

Compliance:

mandatory - This method must be implemented.

clearOperationalTerms

void clearOperationalTerms()

Clears the operational query terms.

Compliance:

mandatory - This method must be implemented.