public interface RelationshipEnablerQuery extends OsidEnablerQuery
This is the query for searching relationship enablers. Each method
match specifies an AND
term while multiple invocations of
the same method produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearFamilyIdTerms()
Clears the family
Id query terms. |
void |
clearFamilyTerms()
Clears the family query terms.
|
void |
clearRuledRelationshipIdTerms()
Clears the relationship
Id query terms. |
void |
clearRuledRelationshipTerms()
Clears the relationship query terms.
|
FamilyQuery |
getFamilyQuery()
Gets the query for a family.
|
RelationshipEnablerQueryRecord |
getRelationshipEnablerQueryRecord(Type relationshipEnablerRecordType)
Gets the relationship enabler query record corresponding to the given
RelationshipEnabler record Type. |
RelationshipQuery |
getRuledRelationshipQuery()
Gets the query for a relationship.
|
void |
matchAnyRuledRelationship(boolean match)
Matches enablers mapped to any relationship.
|
void |
matchFamilyId(Id familyId,
boolean match)
Matches enablers mapped to a family.
|
void |
matchRuledRelationshipId(Id relationshipId,
boolean match)
Matches enablers mapped to the relationship.
|
boolean |
supportsFamilyQuery()
Tests if a
FamilyQuery is available. |
boolean |
supportsRuledRelationshipQuery()
Tests if a
RelationshipQuery is available. |
clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchRuledRelationshipId(Id relationshipId, boolean match)
relationshipId
- the relationship Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- relationshipId
is null
mandatory
- This method must be implemented. void clearRuledRelationshipIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledRelationshipQuery()
RelationshipQuery
is available. true
if a relationship query is available,
false
otherwisemandatory
- This method must be implemented. RelationshipQuery getRuledRelationshipQuery()
OR
term.UnimplementedException
-
supportsRuledRelationshipQuery()
is false
optional
- This method must be implemented if
supportsRuledRelationshipQuery()
is true.
void matchAnyRuledRelationship(boolean match)
match
- true
for enablers mapped to any
relationship, false
to match enablers mapped to
no relationshipmandatory
- This method must be implemented. void clearRuledRelationshipTerms()
mandatory
- This method must be implemented. void matchFamilyId(Id familyId, boolean match)
familyId
- the family Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- familyId
is
null
mandatory
- This method must be implemented. void clearFamilyIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsFamilyQuery()
FamilyQuery
is available. true
if a family query is available,
false
otherwisemandatory
- This method must be implemented. FamilyQuery getFamilyQuery()
OR
term.UnimplementedException
- supportsFamilyQuery()
is false
optional
- This method must be implemented if
supportsFamilyQuery()
is true.
void clearFamilyTerms()
mandatory
- This method must be implemented. RelationshipEnablerQueryRecord getRelationshipEnablerQueryRecord(Type relationshipEnablerRecordType) throws OperationFailedException
RelationshipEnabler
record Type.
Multiple record retrievals produce a nested OR
term.relationshipEnablerRecordType
- a relationship enabler record
typeNullArgumentException
-
relationshipEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(relationshipEnablerRecordType)
is
false
mandatory
- This method must be implemented.