org.osid.topology.rules

Interface EdgeEnablerQuery

All Superinterfaces:

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

public interface EdgeEnablerQuery
extends OsidEnablerQuery

This is the query for searching edge 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	clearGraphIdTerms() Clears the graph Id query terms.
void	clearGraphTerms() Clears the graph query terms.
void	clearRuledEdgeIdTerms() Clears the edge Id query terms.
void	clearRuledEdgeTerms() Clears the edge query terms.
EdgeEnablerQueryRecord	getEdgeEnablerQueryRecord(Type edgeEnablerRecordType) Gets the edge enabler query record corresponding to the given EdgeEnabler record Type.
GraphQuery	getGraphQuery() Gets the query for a graph.
EdgeQuery	getRuledEdgeQuery() Gets the query for an edge.
void	matchAnyRuledEdge(boolean match) Matches enablers mapped to any edge.
void	matchGraphId(Id graphId, boolean match) Matches enablers mapped to the graph.
void	matchRuledEdgeId(Id edgeId, boolean match) Matches enablers mapped to the edge.
boolean	supportsGraphQuery() Tests if a GraphQuery is available.
boolean	supportsRuledEdgeQuery() Tests if an EdgeQuery 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

matchRuledEdgeId

void matchRuledEdgeId(Id edgeId,
                    boolean match)

Matches enablers mapped to the edge.

Parameters:

edgeId - the edge Id

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

Throws:

NullArgumentException - edgeId is null

Compliance:

mandatory - This method must be implemented.

clearRuledEdgeIdTerms

void clearRuledEdgeIdTerms()

Clears the edge Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledEdgeQuery

boolean supportsRuledEdgeQuery()

Tests if an EdgeQuery is available.

Returns:

true if an edge query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledEdgeQuery

EdgeQuery getRuledEdgeQuery()

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

Returns:

the edge query

Throws:

UnimplementedException - supportsRuledEdgeQuery() is false

Compliance:

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

matchAnyRuledEdge

void matchAnyRuledEdge(boolean match)

Matches enablers mapped to any edge.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledEdgeTerms

void clearRuledEdgeTerms()

Clears the edge query terms.

Compliance:

mandatory - This method must be implemented.

matchGraphId

void matchGraphId(Id graphId,
                boolean match)

Matches enablers mapped to the graph.

Parameters:

graphId - the graph Id

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

Throws:

NullArgumentException - graphId is null

Compliance:

mandatory - This method must be implemented.

clearGraphIdTerms

void clearGraphIdTerms()

Clears the graph Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsGraphQuery

boolean supportsGraphQuery()

Tests if a GraphQuery is available.

Returns:

true if a graph query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGraphQuery

GraphQuery getGraphQuery()

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

Returns:

the graph query

Throws:

UnimplementedException - supportsGraphQuery() is false

Compliance:

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

clearGraphTerms

void clearGraphTerms()

Clears the graph query terms.

Compliance:

mandatory - This method must be implemented.

getEdgeEnablerQueryRecord

EdgeEnablerQueryRecord getEdgeEnablerQueryRecord(Type edgeEnablerRecordType)
                                                 throws OperationFailedException

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

Parameters:

edgeEnablerRecordType - an edge enabler record type

Returns:

the edge enabler query record

Throws:

NullArgumentException - edgeEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(edgeEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.