public interface ResourceRelationshipQuery extends OsidRelationshipQuery
This is the query for searching resource relationships. Each method
match request produces an AND
term while multiple
invocations of a method produces a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearBinIdTerms()
Clears the bin
Id terms. |
void |
clearBinTerms()
Clears the bin terms.
|
void |
clearDestinationResourceIdTerms()
Clears the peer resource
Id terms. |
void |
clearDestinationResourceTerms()
Clears the peer resource terms.
|
void |
clearSameResourceTerms()
Clears the same resource terms.
|
void |
clearSourceResourceIdTerms()
Clears the resource
Id terms. |
void |
clearSourceResourceTerms()
Clears the resource terms.
|
BinQuery |
getBinQuery()
Gets the query for a bin.
|
ResourceQuery |
getDestinationResourceQuery()
Gets the query for a resource.
|
ResourceRelationshipQueryRecord |
getResourceRelationshipQueryRecord(Type resourceRelationshipRecordType)
Gets the resource relationship query record corresponding to the given
ResourceRelationship record Type. |
ResourceQuery |
getSourceResourceQuery()
Gets the query for a resource.
|
void |
matchBinId(Id binId,
boolean match)
Sets the bin
Id for this query to match terms assigned
to bins. |
void |
matchDestinationResourceId(Id peerResourceId,
boolean match)
Sets the peer resource
Id for this query. |
void |
matchSameResource(boolean match)
Matches relationships where the peer resources are the same.
|
void |
matchSourceResourceId(Id resourceId,
boolean match)
Sets the resource
Id for this query. |
boolean |
supportsBinQuery()
Tests if a
BinQuery is available. |
boolean |
supportsDestinationResourceQuery()
Tests if a
ResourceQuery is available for querying
resources. |
boolean |
supportsSourceResourceQuery()
Tests if a
ResourceQuery is available for querying
resources. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchSourceResourceId(Id resourceId, boolean match)
Id
for this query.resourceId
- a resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearSourceResourceIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsSourceResourceQuery()
ResourceQuery
is available for querying
resources. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getSourceResourceQuery()
OR
term.UnimplementedException
-
supportsSourceResourceQuery()
is false
optional
- This method must be implemented if
supportsSourceResourceQuery()
is true.
void clearSourceResourceTerms()
mandatory
- This method must be implemented. void matchDestinationResourceId(Id peerResourceId, boolean match)
Id
for this query.peerResourceId
- a peer resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- peerResourceId
is null
mandatory
- This method must be implemented. void clearDestinationResourceIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDestinationResourceQuery()
ResourceQuery
is available for querying
resources. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getDestinationResourceQuery()
OR
term.UnimplementedException
-
supportsDestinationResourceQuery()
is false
optional
- This method must be implemented if
supportsDestinationResourceQuery()
is true.
void clearDestinationResourceTerms()
mandatory
- This method must be implemented. void matchSameResource(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearSameResourceTerms()
mandatory
- This method must be implemented. void matchBinId(Id binId, boolean match)
Id
for this query to match terms assigned
to bins.binId
- the bin Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- binId
is
null
mandatory
- This method must be implemented. void clearBinIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsBinQuery()
BinQuery
is available. true
if a bin query is available, false
otherwisemandatory
- This method must be implemented. BinQuery getBinQuery()
OR
term.UnimplementedException
- supportsBinQuery()
is false
optional
- This method must be implemented if
supportsBinQuery()
is true.
void clearBinTerms()
mandatory
- This method must be implemented. ResourceRelationshipQueryRecord getResourceRelationshipQueryRecord(Type resourceRelationshipRecordType) throws OperationFailedException
ResourceRelationship
record Type.
Multiple retrievals produce a nested OR
term.resourceRelationshipRecordType
- a resource relationship query
record typeNullArgumentException
-
resourceRelationshipRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(resourceRelationshipRecordType)
is
false
mandatory
- This method must be implemented.