Class AbstractOsidEnablerQuery

java.lang.Object

net.okapia.osid.jamocha.spi.AbstractOsidQuery

net.okapia.osid.jamocha.spi.AbstractOsidIdentifiableQuery

net.okapia.osid.jamocha.spi.AbstractOsidObjectQuery

net.okapia.osid.jamocha.spi.AbstractOperableOsidObjectQuery

net.okapia.osid.jamocha.spi.AbstractOsidRuleQuery

net.okapia.osid.jamocha.spi.AbstractOsidEnablerQuery

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractActionEnablerQuery, AbstractAuctionConstrainerEnablerQuery, AbstractAuctionProcessorEnablerQuery, AbstractAuditEnablerQuery, AbstractAvailabilityEnablerQuery, AbstractBallotConstrainerEnablerQuery, AbstractBrokerConstrainerEnablerQuery, AbstractBrokerProcessorEnablerQuery, AbstractCanonicalUnitEnablerQuery, AbstractCanonicalUnitProcessorEnablerQuery, AbstractCatalogEnablerQuery, AbstractCommissionEnablerQuery, AbstractCommitmentEnablerQuery, AbstractCompositionEnablerQuery, AbstractContactEnablerQuery, AbstractDemographicEnablerQuery, AbstractDeviceEnablerQuery, AbstractEdgeEnablerQuery, AbstractHoldEnablerQuery, AbstractInputEnablerQuery, AbstractInquiryEnablerQuery, AbstractJobConstrainerEnablerQuery, AbstractJobProcessorEnablerQuery, AbstractObstacleEnablerQuery, AbstractOfferingConstrainerEnablerQuery, AbstractOffsetEventEnablerQuery, AbstractOsidEffectuatorQuery, AbstractOsidRuleApplicatorQuery, AbstractParameterProcessorEnablerQuery, AbstractPoolConstrainerEnablerQuery, AbstractPoolProcessorEnablerQuery, AbstractPriceEnablerQuery, AbstractProcessEnablerQuery, AbstractProfileEntryEnablerQuery, AbstractQueueConstrainerEnablerQuery, AbstractQueueConstrainerEnablerQuery, AbstractQueueProcessorEnablerQuery, AbstractQueueProcessorEnablerQuery, AbstractRaceConstrainerEnablerQuery, AbstractRaceProcessorEnablerQuery, AbstractRecurringEventEnablerQuery, AbstractRelationshipEnablerQuery, AbstractRelevancyEnablerQuery, AbstractRequisiteQuery, AbstractSequenceRuleEnablerQuery, AbstractSignalEnablerQuery, AbstractSpeedZoneEnablerQuery, AbstractStepConstrainerEnablerQuery, AbstractStepProcessorEnablerQuery, AbstractSubscriptionEnablerQuery, AbstractSupersedingEventEnablerQuery, AbstractTriggerEnablerQuery, AbstractValueEnablerQuery

public abstract class AbstractOsidEnablerQuery
extends AbstractOsidRuleQuery
implements OsidEnablerQuery

Defines an OsidEnablerQuery.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractOsidEnablerQuery.OsidTemporalQuery	Composed OsidTemporalQuery.

Nested classes/interfaces inherited from class AbstractOperableOsidObjectQuery

AbstractOperableOsidObjectQuery.OsidOperableQuery

Modifier and Type	Class	Description
protected class	AbstractOperableOsidObjectQuery.OsidOperableQuery	Composed OsidOperableQuery.

Nested classes/interfaces inherited from class AbstractOsidObjectQuery

AbstractOsidObjectQuery.OsidBrowsableQuery

Modifier and Type	Class	Description
protected class	AbstractOsidObjectQuery.OsidBrowsableQuery	Composed OsidBrowsableQuery.

Constructor Summary

Constructors

Constructor	Description
AbstractOsidEnablerQuery()	Constructs a new AbstractOsidEnablerQuery.

Method Summary

Modifier and Type	Method	Description
void	clearCyclicEventIdTerms()	Clears the cyclic event Id query terms.
void	clearCyclicEventTerms()	Clears the cyclic event query terms.
void	clearCyclicTimePeriodIdTerms()	Clears the cyclic time period Id query terms.
void	clearCyclicTimePeriodTerms()	Clears the cyclic time period query terms.
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearEventIdTerms()	Clears all event Id terms.
void	clearEventTerms()	Clears all recurirng event terms.
void	clearRequirementTerms()	Clears all requirement terms.
void	clearScheduleIdTerms()	Clears all schedule Id terms.
void	clearScheduleTerms()	Clears all schedule terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	clearTimePeriodIdTerms()	Clears the time period Id query terms.
void	clearTimePeriodTerms()	Clears the time period query terms.
CyclicEventQuery	getCyclicEventQuery()	Gets the query for a cyclic event.
CyclicTimePeriodQuery	getCyclicTimePeriodQuery()	Gets the query for a cyclic time period.
EventQuery	getEventQuery(boolean match)	Gets the query for the event.
ScheduleQuery	getScheduleQuery(boolean match)	Gets the query for the schedule.
TimePeriodQuery	getTimePeriodQuery()	Gets the query for a time period.
void	matchAnyCyclicEvent(boolean match)	Matches any enabler with a cyclic event.
void	matchAnyCyclicTimePeriod(boolean match)	Matches any enabler with a cyclic time period.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyEvent(boolean match)	Match any associated event.
void	matchAnyRequirement(boolean match)	Matches OsidEnablers with any requirement flag set.
void	matchAnySchedule(boolean match)	Match any associated schedule.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchAnyTimePeriod(boolean match)	Matches any enabler with a time period.
void	matchCyclicEventId(Id cyclicEventId, boolean match)	Sets the cyclic event Id for this query.
void	matchCyclicTimePeriodId(Id cyclicTimePeriodId, boolean match)	Sets the cyclic time period Id for this query.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date is included within the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchEventId(Id eventId, boolean match)	Match the Id of an associated event.
void	matchRequirement(boolean match)	Matches enablers that are requirements.
void	matchScheduleId(Id scheduleId, boolean match)	Match the Id of an associated schedule.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.
void	matchTimePeriodId(Id timePeriodId, boolean match)	Sets the time period Id for this query.
boolean	supportsCyclicEventQuery()	Tests if a CyclicEventQuery is available.
boolean	supportsCyclicTimePeriodQuery()	Tests if a CyclicTimePeriodQuery is available.
boolean	supportsEventQuery()	Tests if a EventQuery for the rule is available.
boolean	supportsScheduleQuery()	Tests if a ScheduleQuery for the rule is available.
boolean	supportsTimePeriodQuery()	Tests if a TimePeriodQuery is available.

Methods inherited from class AbstractOsidRuleQuery

clearConditionRecordTypeTerms, clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyConditionRecordType, matchAnyRule, matchConditionRecordType, matchRuleId, supportsRuleQuery

Modifier and Type	Method	Description
void	clearConditionRecordTypeTerms()	Clears the condition record Type query terms.
void	clearRuleIdTerms()	Clears all rule Id terms.
void	clearRuleTerms()	Clears all rule terms.
RuleQuery	getRuleQuery(boolean match)	Gets the query for the rule.
void	matchAnyConditionRecordType(boolean match)	Matches rules with any condition record type.
void	matchAnyRule(boolean match)	Match any associated rule.
void	matchConditionRecordType(Type conditionRecordType, boolean match)	Matches a condition record type.
void	matchRuleId(Id ruleId, boolean match)	Match the Id of the rule.
boolean	supportsRuleQuery()	Tests if a RuleQuery for the rule is available.

Methods inherited from class AbstractOperableOsidObjectQuery

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

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 class AbstractOsidObjectQuery

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

Modifier and Type	Method	Description
protected void	addRecordType(Type recordType)	Adds a record type.
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRecordTerms()	Clears all record Type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
protected Collection<StringTerm>	getDescriptionTerms()	Gets all the description query terms.
protected Collection<StringTerm>	getDisplayNameTerms()	Gets all the display name query terms.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
TypeList	getRecordTypes()	Gets the record types available in this object.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.
void	matchAnyComment(boolean match)	Matches an object that has any Comment .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit for the given Meter.
void	matchAnyDescription(boolean match)	Matches any object with a description.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject.
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id.
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects.
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects.

Methods inherited from class AbstractOsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from class AbstractOsidQuery

addStringMatchType, clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
protected void	addStringMatchType(Type stringMatchType)	Adds a string match type.
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.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractOsidEnablerQuery

public AbstractOsidEnablerQuery()

Constructs a new AbstractOsidEnablerQuery.

Method Details

matchRequirement

@OSID
public void matchRequirement(boolean match)

Matches enablers that are requirements.

Specified by:

matchRequirement in interface OsidEnablerQuery

Parameters:

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

matchAnyRequirement

@OSID
public void matchAnyRequirement(boolean match)

Matches OsidEnablers with any requirement flag set.

Specified by:

matchAnyRequirement in interface OsidEnablerQuery

Parameters:

match - true to match any requirement setting, false otherwise

clearRequirementTerms

@OSID
public void clearRequirementTerms()

Clears all requirement terms.

Specified by:

clearRequirementTerms in interface OsidEnablerQuery

matchScheduleId

@OSID
public void matchScheduleId(Id scheduleId,
 boolean match)

Match the Id of an associated schedule.

Specified by:

matchScheduleId in interface OsidEnablerQuery

Parameters:

scheduleId - Id to match

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

Throws:

NullArgumentException - scheduleId is null

clearScheduleIdTerms

@OSID
public void clearScheduleIdTerms()

Clears all schedule Id terms.

Specified by:

clearScheduleIdTerms in interface OsidEnablerQuery

supportsScheduleQuery

@OSID
public boolean supportsScheduleQuery()

Tests if a ScheduleQuery for the rule is available.

Specified by:

supportsScheduleQuery in interface OsidEnablerQuery

Returns:

true if a schedule query is available, false otherwise

getScheduleQuery

@OSID
public ScheduleQuery getScheduleQuery(boolean match)

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

Specified by:

getScheduleQuery in interface OsidEnablerQuery

Parameters:

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

Returns:

the schedule query

Throws:

UnimplementedException - supportsScheduleQuery() is false

matchAnySchedule

@OSID
public void matchAnySchedule(boolean match)

Match any associated schedule.

Specified by:

matchAnySchedule in interface OsidEnablerQuery

Parameters:

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

clearScheduleTerms

@OSID
public void clearScheduleTerms()

Clears all schedule terms.

Specified by:

clearScheduleTerms in interface OsidEnablerQuery

matchEventId

@OSID
public void matchEventId(Id eventId,
 boolean match)

Match the Id of an associated event.

Specified by:

matchEventId in interface OsidEnablerQuery

Parameters:

eventId - Id to match

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

Throws:

NullArgumentException - eventId is null

clearEventIdTerms

@OSID
public void clearEventIdTerms()

Clears all event Id terms.

Specified by:

clearEventIdTerms in interface OsidEnablerQuery

supportsEventQuery

@OSID
public boolean supportsEventQuery()

Tests if a EventQuery for the rule is available.

Specified by:

supportsEventQuery in interface OsidEnablerQuery

Returns:

true if an event query is available, false otherwise

getEventQuery

@OSID
public EventQuery getEventQuery(boolean match)

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

Specified by:

getEventQuery in interface OsidEnablerQuery

Parameters:

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

Returns:

the event query

Throws:

UnimplementedException - supportsEventQuery() is false

matchAnyEvent

@OSID
public void matchAnyEvent(boolean match)

Match any associated event.

Specified by:

matchAnyEvent in interface OsidEnablerQuery

Parameters:

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

clearEventTerms

@OSID
public void clearEventTerms()

Clears all recurirng event terms.

Specified by:

clearEventTerms in interface OsidEnablerQuery

matchCyclicEventId

@OSID
public void matchCyclicEventId(Id cyclicEventId,
 boolean match)

Sets the cyclic event Id for this query.

Specified by:

matchCyclicEventId in interface OsidEnablerQuery

Parameters:

cyclicEventId - the cyclic event Id

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

Throws:

NullArgumentException - cyclicEventId is null

clearCyclicEventIdTerms

@OSID
public void clearCyclicEventIdTerms()

Clears the cyclic event Id query terms.

Specified by:

clearCyclicEventIdTerms in interface OsidEnablerQuery

supportsCyclicEventQuery

@OSID
public boolean supportsCyclicEventQuery()

Tests if a CyclicEventQuery is available.

Specified by:

supportsCyclicEventQuery in interface OsidEnablerQuery

Returns:

true if a cyclic event query is available, false otherwise

getCyclicEventQuery

@OSID
public CyclicEventQuery getCyclicEventQuery()

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

Specified by:

getCyclicEventQuery in interface OsidEnablerQuery

Returns:

the cyclic event query

Throws:

UnimplementedException - supportsCyclicEventQuery() is false

matchAnyCyclicEvent

@OSID
public void matchAnyCyclicEvent(boolean match)

Matches any enabler with a cyclic event.

Specified by:

matchAnyCyclicEvent in interface OsidEnablerQuery

Parameters:

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

clearCyclicEventTerms

@OSID
public void clearCyclicEventTerms()

Clears the cyclic event query terms.

Specified by:

clearCyclicEventTerms in interface OsidEnablerQuery

matchTimePeriodId

@OSID
public void matchTimePeriodId(Id timePeriodId,
 boolean match)

Sets the time period Id for this query.

Specified by:

matchTimePeriodId in interface OsidEnablerQuery

Parameters:

timePeriodId - the time period Id

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

Throws:

NullArgumentException - timePeriodId is null

clearTimePeriodIdTerms

@OSID
public void clearTimePeriodIdTerms()

Clears the time period Id query terms.

Specified by:

clearTimePeriodIdTerms in interface OsidEnablerQuery

supportsTimePeriodQuery

@OSID
public boolean supportsTimePeriodQuery()

Tests if a TimePeriodQuery is available.

Specified by:

supportsTimePeriodQuery in interface OsidEnablerQuery

Returns:

true if a time period query is available, false otherwise

getTimePeriodQuery

@OSID
public TimePeriodQuery getTimePeriodQuery()

Gets the query for a time period. Multiple retrievals produce a nested OR term.

Specified by:

getTimePeriodQuery in interface OsidEnablerQuery

Returns:

the time period query

Throws:

UnimplementedException - supportsTimePeriodQuery() is false

matchAnyTimePeriod

@OSID
public void matchAnyTimePeriod(boolean match)

Matches any enabler with a time period.

Specified by:

matchAnyTimePeriod in interface OsidEnablerQuery

Parameters:

match - true to match any enablers with a time period, false to match enablers with no time period

clearTimePeriodTerms

@OSID
public void clearTimePeriodTerms()

Clears the time period query terms.

Specified by:

clearTimePeriodTerms in interface OsidEnablerQuery

matchCyclicTimePeriodId

@OSID
public void matchCyclicTimePeriodId(Id cyclicTimePeriodId,
 boolean match)

Sets the cyclic time period Id for this query.

Specified by:

matchCyclicTimePeriodId in interface OsidEnablerQuery

Parameters:

cyclicTimePeriodId - the cyclic time period Id

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

Throws:

NullArgumentException - cyclicTimePeriodId is null

clearCyclicTimePeriodIdTerms

@OSID
public void clearCyclicTimePeriodIdTerms()

Clears the cyclic time period Id query terms.

Specified by:

clearCyclicTimePeriodIdTerms in interface OsidEnablerQuery

supportsCyclicTimePeriodQuery

@OSID
public boolean supportsCyclicTimePeriodQuery()

Tests if a CyclicTimePeriodQuery is available.

Specified by:

supportsCyclicTimePeriodQuery in interface OsidEnablerQuery

Returns:

true if a cyclic time period query is available, false otherwise

getCyclicTimePeriodQuery

@OSID
public CyclicTimePeriodQuery getCyclicTimePeriodQuery()

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

Specified by:

getCyclicTimePeriodQuery in interface OsidEnablerQuery

Returns:

the cyclic time period query

Throws:

UnimplementedException - supportsCyclicTimePeriodQuery() is false

matchAnyCyclicTimePeriod

@OSID
public void matchAnyCyclicTimePeriod(boolean match)

Matches any enabler with a cyclic time period.

Specified by:

matchAnyCyclicTimePeriod in interface OsidEnablerQuery

Parameters:

match - true to match any enablers with a cyclic time period, false to match enablers with no cyclic time period

clearCyclicTimePeriodTerms

@OSID
public void clearCyclicTimePeriodTerms()

Clears the cyclic time period query terms.

Specified by:

clearCyclicTimePeriodTerms in interface OsidEnablerQuery

matchEffective

@OSID
public void matchEffective(boolean match)

Match effective objects where the current date falls within the start and end dates inclusive.

Specified by:

matchEffective in interface OsidTemporalQuery

Parameters:

match - true to match any effective, false to match ineffective

clearEffectiveTerms

@OSID
public void clearEffectiveTerms()

Clears the effective query terms.

Specified by:

clearEffectiveTerms in interface OsidTemporalQuery

matchStartDate

@OSID
public void matchStartDate(DateTime start,
 DateTime end,
 boolean match)

Matches temporals whose start date falls in between the given dates inclusive.

Specified by:

matchStartDate in interface OsidTemporalQuery

Parameters:

start - start of date range

end - end of date range

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

Throws:

InvalidArgumentException - start is less than end

NullArgumentException - start or end is null

matchAnyStartDate

@OSID
public void matchAnyStartDate(boolean match)

Matches temporals with any start date set.

Specified by:

matchAnyStartDate in interface OsidTemporalQuery

Parameters:

match - true to match any start date, false to match no start date

clearStartDateTerms

@OSID
public void clearStartDateTerms()

Clears the start date query terms.

Specified by:

clearStartDateTerms in interface OsidTemporalQuery

matchEndDate

@OSID
public void matchEndDate(DateTime start,
 DateTime end,
 boolean match)

Matches temporals whose effective end date falls in between the given dates inclusive.

Specified by:

matchEndDate in interface OsidTemporalQuery

Parameters:

start - start of date range

end - end of date range

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

Throws:

InvalidArgumentException - start is less than end

NullArgumentException - start or end is null

matchAnyEndDate

@OSID
public void matchAnyEndDate(boolean match)

Matches temporals with any end date set.

Specified by:

matchAnyEndDate in interface OsidTemporalQuery

Parameters:

match - true to match any end date, false to match no start date

clearEndDateTerms

@OSID
public void clearEndDateTerms()

Clears the end date query terms.

Specified by:

clearEndDateTerms in interface OsidTemporalQuery

matchDate

@OSID
public void matchDate(DateTime from,
 DateTime to,
 boolean match)

Matches temporals where the given date is included within the start and end dates inclusive.

Specified by:

matchDate in interface OsidTemporalQuery

Parameters:

from - start date

to - end datedate

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

Throws:

InvalidArgumentException - from is less than to

NullArgumentException - from or to is null

clearDateTerms

@OSID
public void clearDateTerms()

Clears the date query terms.

Specified by:

clearDateTerms in interface OsidTemporalQuery