Interface OsidEffectuatorQuery

All Superinterfaces:

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

All Known Subinterfaces:

AuthorizationEnablerQuery

public interface OsidEffectuatorQuery
extends OsidEnablerQuery

This is the query interface for searching OsidEffecuators. 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	clearCreateOnceTerms()	Clears all create once terms.
void	clearMinimumContinuityGapTerms()	Clears all minimum continuity gap terms.
void	CreateOnceMinimumContinuityGap(boolean match)	Match any minimum create once flag.
void	matchAnyMinimumContinuityGap(boolean match)	Match any minimum continuity gap.
void	matchCreateOnce(boolean match)	Matches OsidEffectuators with a create once flag.
void	matchMinimumContinuityGap(Duration from, Duration to, boolean match)	Matches OsidEffectuators with a minimum continuity gap between the given durations inclusive.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidEnablerQuery

clearCyclicEventIdTerms, clearCyclicEventTerms, clearCyclicTimePeriodIdTerms, clearCyclicTimePeriodTerms, clearEventIdTerms, clearEventTerms, clearRequirementTerms, clearScheduleIdTerms, clearScheduleTerms, clearTimePeriodIdTerms, clearTimePeriodTerms, getCyclicEventQuery, getCyclicTimePeriodQuery, getEventQuery, getScheduleQuery, getTimePeriodQuery, matchAnyCyclicEvent, matchAnyCyclicTimePeriod, matchAnyEvent, matchAnyRequirement, matchAnySchedule, matchAnyTimePeriod, matchCyclicEventId, matchCyclicTimePeriodId, matchEventId, matchRequirement, matchScheduleId, matchTimePeriodId, supportsCyclicEventQuery, supportsCyclicTimePeriodQuery, supportsEventQuery, supportsScheduleQuery, supportsTimePeriodQuery

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface 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 OsidOperableQuery

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

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface OsidRuleQuery

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

Methods inherited from interface OsidTemporalQuery

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

Method Details

matchCreateOnce

void matchCreateOnce(boolean match)

Matches OsidEffectuators with a create once flag.

Parameters:

match - true to match create once rules, false otherwise

Compliance:

mandatory - This method must be implemented.

CreateOnceMinimumContinuityGap

void CreateOnceMinimumContinuityGap(boolean match)

Match any minimum create once flag.

Parameters:

match - true to match any create once flag, false to match no set create once flag

Compliance:

mandatory - This method must be implemented.

clearCreateOnceTerms

void clearCreateOnceTerms()

Clears all create once terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumContinuityGap

void matchMinimumContinuityGap(Duration from,
 Duration to,
 boolean match)

Matches OsidEffectuators with a minimum continuity gap between the given durations inclusive.

Parameters:

from - start of duration range

to - end of duration range

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

Throws:

NullArgumentException - scheduleId is null

Compliance:

mandatory - This method must be implemented.

matchAnyMinimumContinuityGap

void matchAnyMinimumContinuityGap(boolean match)

Match any minimum continuity gap.

Parameters:

match - true to match any minimum continuity gap, false to match no minimum continuity gaps

Compliance:

mandatory - This method must be implemented.

clearMinimumContinuityGapTerms

void clearMinimumContinuityGapTerms()

Clears all minimum continuity gap terms.

Compliance:

mandatory - This method must be implemented.