org.osid

Interface OsidEnablerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidTemporalQuery, Suppliable

All Known Subinterfaces:

ActionEnablerQuery, AuctionConstrainerEnablerQuery, AuctionProcessorEnablerQuery, AuditEnablerQuery, AuthorizationEnablerQuery, AvailabilityEnablerQuery, BallotConstrainerEnablerQuery, BrokerConstrainerEnablerQuery, BrokerProcessorEnablerQuery, CanonicalUnitEnablerQuery, CanonicalUnitProcessorEnablerQuery, CatalogEnablerQuery, CommissionEnablerQuery, CommitmentEnablerQuery, CompositionEnablerQuery, ContactEnablerQuery, DemographicEnablerQuery, DeviceEnablerQuery, EdgeEnablerQuery, HoldEnablerQuery, InputEnablerQuery, InquiryEnablerQuery, InstructionQuery, JobConstrainerEnablerQuery, JobProcessorEnablerQuery, ObstacleEnablerQuery, OfferingConstrainerEnablerQuery, OffsetEventEnablerQuery, ParameterProcessorEnablerQuery, PoolConstrainerEnablerQuery, PoolProcessorEnablerQuery, PriceEnablerQuery, ProcessEnablerQuery, ProfileEntryEnablerQuery, QueueConstrainerEnablerQuery, QueueConstrainerEnablerQuery, QueueProcessorEnablerQuery, QueueProcessorEnablerQuery, RaceConstrainerEnablerQuery, RaceProcessorEnablerQuery, RecurringEventEnablerQuery, RelationshipEnablerQuery, RelevancyEnablerQuery, RequisiteQuery, SequenceRuleEnablerQuery, SignalEnablerQuery, SpeedZoneEnablerQuery, StepConstrainerEnablerQuery, StepProcessorEnablerQuery, SubscriptionEnablerQuery, SupersedingEventEnablerQuery, TriggerEnablerQuery, ValueEnablerQuery

public interface OsidEnablerQuery
extends OsidRuleQuery, OsidTemporalQuery

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCyclicEventIdTerms() Clears the cyclic event Id query terms.
void	clearCyclicEventTerms() Clears the cyclic event query terms.
void	clearDemographicIdTerms() Clears all resource Id terms.
void	clearDemographicTerms() Clears all demographic terms.
void	clearEventIdTerms() Clears all event Id terms.
void	clearEventTerms() Clears all recurirng event terms.
void	clearScheduleIdTerms() Clears all schedule Id terms.
void	clearScheduleTerms() Clears all schedule terms.
CyclicEventQuery	getCyclicEventQuery() Gets the query for a cyclic event.
ResourceQuery	getDemographicQuery(boolean match) Gets the query for the resource.
EventQuery	getEventQuery(boolean match) Gets the query for the event.
ScheduleQuery	getScheduleQuery(boolean match) Gets the query for the schedule.
void	matchAnyCyclicEvent(boolean match) Matches any enabler with a cyclic event.
void	matchAnyDemographic(boolean match) Match any associated resource.
void	matchAnyEvent(boolean match) Match any associated event.
void	matchAnySchedule(boolean match) Match any associated schedule.
void	matchCyclicEventId(Id cyclicEventId, boolean match) Sets the cyclic event Id for this query.
void	matchDemographicId(Id resourceId, boolean match) Match the Id of the demographic resource.
void	matchEventId(Id eventId, boolean match) Match the Id of an associated event.
void	matchScheduleId(Id scheduleId, boolean match) Match the Id of an associated schedule.
boolean	supportsCyclicEventQuery() Tests if a CyclicEventQuery is available.
boolean	supportsDemographicQuery() Tests if a ResourceQuery for the demographic is available.
boolean	supportsEventQuery() Tests if a EventQuery for the rule is available.
boolean	supportsScheduleQuery() Tests if a ScheduleQuery for the rule is available.

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchScheduleId

void matchScheduleId(Id scheduleId,
                   boolean match)

Match the Id of an associated schedule.

Parameters:

scheduleId - Id to match

match - true if for a positive match, false for a negative match

Throws:

NullArgumentException - scheduleId is null

Compliance:

mandatory - This method must be implemented.

clearScheduleIdTerms

void clearScheduleIdTerms()

Clears all schedule Id terms.

Compliance:

mandatory - This method must be implemented.

supportsScheduleQuery

boolean supportsScheduleQuery()

Tests if a ScheduleQuery for the rule is available.

Returns:

true if a schedule query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getScheduleQuery

ScheduleQuery getScheduleQuery(boolean match)

Gets the query for the schedule. Each retrieval performs a boolean OR.

Parameters:

match - true if for a positive match, false for a negative match

Returns:

the schedule query

Throws:

UnimplementedException - supportsScheduleQuery() is false

Compliance:

optional - This method must be implemented if supportsScheduleQuery() is true.

matchAnySchedule

void matchAnySchedule(boolean match)

Match any associated schedule.

Parameters:

match - true to match any schedule, false to match no schedules

Compliance:

mandatory - This method must be implemented.

clearScheduleTerms

void clearScheduleTerms()

Clears all schedule terms.

Compliance:

mandatory - This method must be implemented.

matchEventId

void matchEventId(Id eventId,
                boolean match)

Match the Id of an associated event.

Parameters:

eventId - Id to match

match - true if for a positive match, false for a negative match

Throws:

NullArgumentException - eventId is null

Compliance:

mandatory - This method must be implemented.

clearEventIdTerms

void clearEventIdTerms()

Clears all event Id terms.

Compliance:

mandatory - This method must be implemented.

supportsEventQuery

boolean supportsEventQuery()

Tests if a EventQuery for the rule is available.

Returns:

true if an event query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEventQuery

EventQuery getEventQuery(boolean match)

Gets the query for the event. Each retrieval performs a boolean OR.

Parameters:

match - true if for a positive match, false for a negative match

Returns:

the event query

Throws:

UnimplementedException - supportsEventQuery() is false

Compliance:

optional - This method must be implemented if supportsEventQuery() is true.

matchAnyEvent

void matchAnyEvent(boolean match)

Match any associated event.

Parameters:

match - true to match any event, false to match no events

Compliance:

mandatory - This method must be implemented.

clearEventTerms

void clearEventTerms()

Clears all recurirng event terms.

Compliance:

mandatory - This method must be implemented.

matchCyclicEventId

void matchCyclicEventId(Id cyclicEventId,
                      boolean match)

Sets the cyclic event Id for this query.

Parameters:

cyclicEventId - the cyclic event Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - cyclicEventId is null

Compliance:

mandatory - This method must be implemented.

clearCyclicEventIdTerms

void clearCyclicEventIdTerms()

Clears the cyclic event Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsCyclicEventQuery

boolean supportsCyclicEventQuery()

Tests if a CyclicEventQuery is available.

Returns:

true if a cyclic event query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCyclicEventQuery

CyclicEventQuery getCyclicEventQuery()

Gets the query for a cyclic event. Multiple retrievals produce a nested OR term.

Returns:

the cyclic event query

Throws:

UnimplementedException - supportsCyclicEventQuery() is false

Compliance:

optional - This method must be implemented if supportsCyclicEventQuery() is true.

matchAnyCyclicEvent

void matchAnyCyclicEvent(boolean match)

Matches any enabler with a cyclic event.

Parameters:

match - true to match any enablers with a cyclic event, false to match enablers with no cyclic events

Compliance:

mandatory - This method must be implemented.

clearCyclicEventTerms

void clearCyclicEventTerms()

Clears the cyclic event query terms.

Compliance:

mandatory - This method must be implemented.

matchDemographicId

void matchDemographicId(Id resourceId,
                      boolean match)

Match the Id of the demographic resource.

Parameters:

resourceId - Id to match

match - true if for a positive match, false for a negative match

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearDemographicIdTerms

void clearDemographicIdTerms()

Clears all resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDemographicQuery

boolean supportsDemographicQuery()

Tests if a ResourceQuery for the demographic is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDemographicQuery

ResourceQuery getDemographicQuery(boolean match)

Gets the query for the resource. Each retrieval performs a boolean OR.

Parameters:

match - true if for a positive match, false for a negative match

Returns:

the resource query

Throws:

UnimplementedException - supportsResourceQuery() is false

Compliance:

optional - This method must be implemented if supportsResourceQuery() is true.

matchAnyDemographic

void matchAnyDemographic(boolean match)

Match any associated resource.

Parameters:

match - true to match any demographic, false to match no rules

Compliance:

mandatory - This method must be implemented.

clearDemographicTerms

void clearDemographicTerms()

Clears all demographic terms.

Compliance:

mandatory - This method must be implemented.