org.osid.resource

Interface ResourceRelationshipQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

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

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchSourceResourceId

void matchSourceResourceId(Id resourceId,
                         boolean match)

Sets the resource Id for this query.

Parameters:

resourceId - a resource Id

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearSourceResourceIdTerms

void clearSourceResourceIdTerms()

Clears the resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSourceResourceQuery

boolean supportsSourceResourceQuery()

Tests if a ResourceQuery is available for querying resources.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSourceResourceQuery

ResourceQuery getSourceResourceQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsSourceResourceQuery() is false

Compliance:

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

clearSourceResourceTerms

void clearSourceResourceTerms()

Clears the resource terms.

Compliance:

mandatory - This method must be implemented.

matchDestinationResourceId

void matchDestinationResourceId(Id peerResourceId,
                              boolean match)

Sets the peer resource Id for this query.

Parameters:

peerResourceId - a peer resource Id

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

Throws:

NullArgumentException - peerResourceId is null

Compliance:

mandatory - This method must be implemented.

clearDestinationResourceIdTerms

void clearDestinationResourceIdTerms()

Clears the peer resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDestinationResourceQuery

boolean supportsDestinationResourceQuery()

Tests if a ResourceQuery is available for querying resources.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDestinationResourceQuery

ResourceQuery getDestinationResourceQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsDestinationResourceQuery() is false

Compliance:

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

clearDestinationResourceTerms

void clearDestinationResourceTerms()

Clears the peer resource terms.

Compliance:

mandatory - This method must be implemented.

matchSameResource

void matchSameResource(boolean match)

Matches relationships where the peer resources are the same.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearSameResourceTerms

void clearSameResourceTerms()

Clears the same resource terms.

Compliance:

mandatory - This method must be implemented.

matchBinId

void matchBinId(Id binId,
              boolean match)

Sets the bin Id for this query to match terms assigned to bins.

Parameters:

binId - the bin Id

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

Throws:

NullArgumentException - binId is null

Compliance:

mandatory - This method must be implemented.

clearBinIdTerms

void clearBinIdTerms()

Clears the bin Id terms.

Compliance:

mandatory - This method must be implemented.

supportsBinQuery

boolean supportsBinQuery()

Tests if a BinQuery is available.

Returns:

true if a bin query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBinQuery

BinQuery getBinQuery()

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

Returns:

the bin query

Throws:

UnimplementedException - supportsBinQuery() is false

Compliance:

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

clearBinTerms

void clearBinTerms()

Clears the bin terms.

Compliance:

mandatory - This method must be implemented.

getResourceRelationshipQueryRecord

ResourceRelationshipQueryRecord getResourceRelationshipQueryRecord(Type resourceRelationshipRecordType)
                                                                   throws OperationFailedException

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

Parameters:

resourceRelationshipRecordType - a resource relationship query record type

Returns:

the resource relationship query record

Throws:

NullArgumentException - resourceRelationshipRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(resourceRelationshipRecordType) is false

Compliance:

mandatory - This method must be implemented.