org.osid.relationship.rules

Interface RelationshipEnablerQuery

All Superinterfaces:

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

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidEnablerQuery

clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery

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

matchRuledRelationshipId

void matchRuledRelationshipId(Id relationshipId,
                            boolean match)

Matches enablers mapped to the relationship.

Parameters:

relationshipId - the relationship Id

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

Throws:

NullArgumentException - relationshipId is null

Compliance:

mandatory - This method must be implemented.

clearRuledRelationshipIdTerms

void clearRuledRelationshipIdTerms()

Clears the relationship Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledRelationshipQuery

boolean supportsRuledRelationshipQuery()

Tests if a RelationshipQuery is available.

Returns:

true if a relationship query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledRelationshipQuery

RelationshipQuery getRuledRelationshipQuery()

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

Returns:

the relationship query

Throws:

UnimplementedException - supportsRuledRelationshipQuery() is false

Compliance:

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

matchAnyRuledRelationship

void matchAnyRuledRelationship(boolean match)

Matches enablers mapped to any relationship.

Parameters:

match - true for enablers mapped to any relationship, false to match enablers mapped to no relationship

Compliance:

mandatory - This method must be implemented.

clearRuledRelationshipTerms

void clearRuledRelationshipTerms()

Clears the relationship query terms.

Compliance:

mandatory - This method must be implemented.

matchFamilyId

void matchFamilyId(Id familyId,
                 boolean match)

Matches enablers mapped to a family.

Parameters:

familyId - the family Id

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

Throws:

NullArgumentException - familyId is null

Compliance:

mandatory - This method must be implemented.

clearFamilyIdTerms

void clearFamilyIdTerms()

Clears the family Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsFamilyQuery

boolean supportsFamilyQuery()

Tests if a FamilyQuery is available.

Returns:

true if a family query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFamilyQuery

FamilyQuery getFamilyQuery()

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

Returns:

the family query

Throws:

UnimplementedException - supportsFamilyQuery() is false

Compliance:

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

clearFamilyTerms

void clearFamilyTerms()

Clears the family query terms.

Compliance:

mandatory - This method must be implemented.

getRelationshipEnablerQueryRecord

RelationshipEnablerQueryRecord getRelationshipEnablerQueryRecord(Type relationshipEnablerRecordType)
                                                                 throws OperationFailedException

Gets the relationship enabler query record corresponding to the given RelationshipEnabler record Type. Multiple record retrievals produce a nested OR term.

Parameters:

relationshipEnablerRecordType - a relationship enabler record type

Returns:

the relationship enabler query record

Throws:

NullArgumentException - relationshipEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relationshipEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.