Interface SupersedingEventQuery

All Superinterfaces:

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

public interface SupersedingEventQuery
extends OsidRuleQuery

This is the query for searching superseding events. Each method match request produces an AND term while multiple invocations of a method produces a nested OR .

Method Summary

Modifier and Type	Method	Description
void	clearCalendarIdTerms()	Clears the calendar Id terms.
void	clearCalendarTerms()	Clears the calendar terms.
void	clearSupersededDateTerms()	Clears the superseded date terms.
void	clearSupersededEventIdTerms()	Clears the event Id terms.
void	clearSupersededEventPositionTerms()	Clears the superseded position terms.
void	clearSupersededEventTerms()	Clears the event terms.
void	clearSupersedingEventIdTerms()	Clears the superseding event Id terms.
void	clearSupersedingEventTerms()	Clears the superseding event terms.
CalendarQuery	getCalendarQuery()	Gets the query for a calendar.
EventQuery	getSupersededEventQuery()	Gets the query for an attached event.
EventQuery	getSupersedingEventQuery()	Gets the query for a superseding event.
SupersedingEventQueryRecord	getSupersedingEventQueryRecord(Type supersedingEventRecordType)	Gets the superseding event query record corresponding to the given SupersedingEvent record Type .
void	matchAnySupersededDate(boolean match)	Matches a superseding event that has any superseded date.
void	matchAnySupersededEventPosition(boolean match)	Matches a superseding event that has any superseded position.
void	matchCalendarId(Id calendarId, boolean match)	Sets the calendar Id for this query.
void	matchSupersededDate(DateTime from, DateTime to, boolean match)	Matches superseding events that supersede within the given dates inclusive.
void	matchSupersededEventId(Id eventId, boolean match)	Sets the event Id for this query for matching attached events.
void	matchSupersededEventPosition(long from, long to, boolean match)	Matches superseding events that supersede within the denormalized event positions inclusive.
void	matchSupersedingEventId(Id supersedingEventId, boolean match)	Sets the superseding event Id for this query.
boolean	supportsCalendarQuery()	Tests if a CalendarQuery is available for querying calendars.
boolean	supportsSupersededEventQuery()	Tests if an EventQuery is available for querying attached events.
boolean	supportsSupersedingEventQuery()	Tests if a SupersedingEventQuery is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

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

Modifier and Type	Method	Description
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	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.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
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.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
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	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
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 name 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	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 interface OsidOperableQuery

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 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.

Methods inherited from interface OsidRuleQuery

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.

Method Details

matchSupersededEventId

void matchSupersededEventId(Id eventId,
 boolean match)

Sets the event Id for this query for matching attached events.

Parameters:

eventId - an event Id

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

Throws:

NullArgumentException - eventId is null

Compliance:

mandatory - This method must be implemented.

clearSupersededEventIdTerms

void clearSupersededEventIdTerms()

Clears the event Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSupersededEventQuery

boolean supportsSupersededEventQuery()

Tests if an EventQuery is available for querying attached events.

Returns:

true if an event query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSupersededEventQuery

EventQuery getSupersededEventQuery()

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

Returns:

the event query

Throws:

UnimplementedException - supportsSupersededEventQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSupersededEventQuery()} is {@code true} .

clearSupersededEventTerms

void clearSupersededEventTerms()

Clears the event terms.

Compliance:

mandatory - This method must be implemented.

matchSupersedingEventId

void matchSupersedingEventId(Id supersedingEventId,
 boolean match)

Sets the superseding event Id for this query.

Parameters:

supersedingEventId - a superseding event Id

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

Throws:

NullArgumentException - supersedingEventId is null

Compliance:

mandatory - This method must be implemented.

clearSupersedingEventIdTerms

void clearSupersedingEventIdTerms()

Clears the superseding event Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSupersedingEventQuery

boolean supportsSupersedingEventQuery()

Tests if a SupersedingEventQuery is available.

Returns:

true if a superseding event query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSupersedingEventQuery

EventQuery getSupersedingEventQuery()

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

Returns:

the superseding event query

Throws:

UnimplementedException - supportsSupersedingEventQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSupersedingEventQuery()} is {@code true} .

clearSupersedingEventTerms

void clearSupersedingEventTerms()

Clears the superseding event terms.

Compliance:

mandatory - This method must be implemented.

matchSupersededDate

void matchSupersededDate(DateTime from,
 DateTime to,
 boolean match)

Matches superseding events that supersede within the given dates inclusive.

Parameters:

from - start date

to - end date

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

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnySupersededDate

void matchAnySupersededDate(boolean match)

Matches a superseding event that has any superseded date.

Parameters:

match - true to match superseding events with any superseded date, false to match superseding events with no superseded date

Compliance:

mandatory - This method must be implemented.

clearSupersededDateTerms

void clearSupersededDateTerms()

Clears the superseded date terms.

Compliance:

mandatory - This method must be implemented.

matchSupersededEventPosition

void matchSupersededEventPosition(long from,
 long to,
 boolean match)

Matches superseding events that supersede within the denormalized event positions inclusive.

Parameters:

from - start position

to - end position

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

Throws:

InvalidArgumentException - the absolute value of from is greater than to

Compliance:

mandatory - This method must be implemented.

matchAnySupersededEventPosition

void matchAnySupersededEventPosition(boolean match)

Matches a superseding event that has any superseded position.

Parameters:

match - true to match superseding events with any superseded event position, false to match superseding events with no superseded event position

Compliance:

mandatory - This method must be implemented.

clearSupersededEventPositionTerms

void clearSupersededEventPositionTerms()

Clears the superseded position terms.

Compliance:

mandatory - This method must be implemented.

matchCalendarId

void matchCalendarId(Id calendarId,
 boolean match)

Sets the calendar Id for this query.

Parameters:

calendarId - a calendar Id

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

Throws:

NullArgumentException - calendarId is null

Compliance:

mandatory - This method must be implemented.

clearCalendarIdTerms

void clearCalendarIdTerms()

Clears the calendar Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCalendarQuery

boolean supportsCalendarQuery()

Tests if a CalendarQuery is available for querying calendars.

Returns:

true if a calendar query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCalendarQuery

CalendarQuery getCalendarQuery()

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

Returns:

the calendar query

Throws:

UnimplementedException - supportsCalendarQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCalendarQuery()} is {@code true} .

clearCalendarTerms

void clearCalendarTerms()

Clears the calendar terms.

Compliance:

mandatory - This method must be implemented.

getSupersedingEventQueryRecord

SupersedingEventQueryRecord getSupersedingEventQueryRecord(Type supersedingEventRecordType)
                                                    throws OperationFailedException

Gets the superseding event query record corresponding to the given SupersedingEvent record Type . Multiple retrievals produce a nested OR term.

Parameters:

supersedingEventRecordType - a superseding event query record type

Returns:

the superseding event query record

Throws:

NullArgumentException - supersedingEventRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(supersedingEventRecordType) is false

Compliance:

mandatory - This method must be implemented.