Interface ResourceQuery

All Superinterfaces:

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

public interface ResourceQuery
extends OsidObjectQuery

This is the query for searching resources. Each method specifies an AND term while multiple invocations of the same method produce a nested OR .

Method Summary

Modifier and Type	Method	Description
void	clearAgentIdTerms()	Clears the agent Id terms.
void	clearAgentTerms()	Clears the agent terms.
void	clearAvatarIdTerms()	Clears the asset Id terms.
void	clearAvatarTerms()	Clears the asset terms.
void	clearBinIdTerms()	Clears the bin Id terms.
void	clearBinTerms()	Clears the bin terms.
void	clearContainingGroupIdTerms()	Clears the group Id terms.
void	clearContainingGroupTerms()	Clears the containing group terms.
void	clearDemographicTerms()	Clears the demographic terms.
void	clearGroupTerms()	Clears the group terms.
void	clearResourceRelationshipIdTerms()	Clears the resource relationship Id terms.
void	clearResourceRelationshipTerms()	Clears the resource relationship terms.
AgentQuery	getAgentQuery()	Gets the query for an agent.
AssetQuery	getAvatarQuery()	Gets the query for an asset.
BinQuery	getBinQuery()	Gets the query for a bin.
ResourceQuery	getContainingGroupQuery()	Gets the query for a containing group.
ResourceQueryRecord	getResourceQueryRecord(Type resourceRecordType)	Gets the resource query record corresponding to the given Resource record Type .Multiple retrievals produce a nested OR term.
ResourceRelationshipQuery	getResourceRelationshipQuery()	Gets the query for aa resource relationship.
void	matchAgentId(Id agentId, boolean match)	Sets the agent Id for this query.
void	matchAnyAgent(boolean match)	Matches resources with any agent.
void	matchAnyAvatar(boolean match)	Matches resources with any asset.
void	matchAnyContainingGroup(boolean match)	Matches resources inside any group.
void	matchAnyResourceRelationship(boolean match)	Matches resources with any resource relationship.
void	matchAvatarId(Id assetId, boolean match)	Sets the asset Id for this query.
void	matchBinId(Id binId, boolean match)	Sets the bin Id for this query.
void	matchContainingGroupId(Id resourceId, boolean match)	Sets the group Id for this query to match resources within the given group.
void	matchDemographic(boolean match)	Matches resources that are also demographics.
void	matchGroup(boolean match)	Matches resources that are also groups.
void	matchResourceRelationshipId(Id resourceRelationshipId, boolean match)	Sets the resource relationship Id for this query.
boolean	supportsAgentQuery()	Tests if an AgentQuery is available.
boolean	supportsAvatarQuery()	Tests if an AssetQuery is available.
boolean	supportsBinQuery()	Tests if a BinQuery is available.
boolean	supportsContainingGroupQuery()	Tests if a ResourceQuery is available for querying containing groups.
boolean	supportsResourceRelationshipQuery()	Tests if a ResourceRelationshipQuery is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

matchGroup

void matchGroup(boolean match)

Matches resources that are also groups.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearGroupTerms

void clearGroupTerms()

Clears the group terms.

Compliance:

mandatory - This method must be implemented.

matchDemographic

void matchDemographic(boolean match)

Matches resources that are also demographics.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDemographicTerms

void clearDemographicTerms()

Clears the demographic terms.

Compliance:

mandatory - This method must be implemented.

matchContainingGroupId

void matchContainingGroupId(Id resourceId,
 boolean match)

Sets the group Id for this query to match resources within the given group.

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.

clearContainingGroupIdTerms

void clearContainingGroupIdTerms()

Clears the group Id terms.

Compliance:

mandatory - This method must be implemented.

supportsContainingGroupQuery

boolean supportsContainingGroupQuery()

Tests if a ResourceQuery is available for querying containing groups.

Returns:

true if a group resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getContainingGroupQuery

ResourceQuery getContainingGroupQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsContainingGroupQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAgentQuery()} is {@code true} .

matchAnyContainingGroup

void matchAnyContainingGroup(boolean match)

Matches resources inside any group.

Parameters:

match - true to match any containing group, false to match resources part of no groups

Compliance:

mandatory - This method must be implemented.

clearContainingGroupTerms

void clearContainingGroupTerms()

Clears the containing group terms.

Compliance:

mandatory - This method must be implemented.

matchAvatarId

void matchAvatarId(Id assetId,
 boolean match)

Sets the asset Id for this query.

Parameters:

assetId - the asset Id

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

Throws:

NullArgumentException - assetId is null

Compliance:

mandatory - This method must be implemented.

clearAvatarIdTerms

void clearAvatarIdTerms()

Clears the asset Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAvatarQuery

boolean supportsAvatarQuery()

Tests if an AssetQuery is available.

Returns:

true if an asset query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAvatarQuery

AssetQuery getAvatarQuery()

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

Returns:

the asset query

Throws:

UnimplementedException - supportsAvatarQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAvatarQuery()} is {@code true} .

matchAnyAvatar

void matchAnyAvatar(boolean match)

Matches resources with any asset.

Parameters:

match - true to match any asset, false to match resources with no asset

Compliance:

mandatory - This method must be implemented.

clearAvatarTerms

void clearAvatarTerms()

Clears the asset terms.

Compliance:

mandatory - This method must be implemented.

matchAgentId

void matchAgentId(Id agentId,
 boolean match)

Sets the agent Id for this query.

Parameters:

agentId - the agent Id

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

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearAgentIdTerms

void clearAgentIdTerms()

Clears the agent Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAgentQuery

boolean supportsAgentQuery()

Tests if an AgentQuery is available.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAgentQuery

AgentQuery getAgentQuery()

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

Returns:

the agent query

Throws:

UnimplementedException - supportsAgentQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAgentQuery()} is {@code true} .

matchAnyAgent

void matchAnyAgent(boolean match)

Matches resources with any agent.

Parameters:

match - true to match any agent, false to match resources with no agent

Compliance:

mandatory - This method must be implemented.

clearAgentTerms

void clearAgentTerms()

Clears the agent terms.

Compliance:

mandatory - This method must be implemented.

matchResourceRelationshipId

void matchResourceRelationshipId(Id resourceRelationshipId,
 boolean match)

Sets the resource relationship Id for this query.

Parameters:

resourceRelationshipId - the resource relationship Id

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

Throws:

NullArgumentException - resourceRelationshipId is null

Compliance:

mandatory - This method must be implemented.

clearResourceRelationshipIdTerms

void clearResourceRelationshipIdTerms()

Clears the resource relationship Id terms.

Compliance:

mandatory - This method must be implemented.

supportsResourceRelationshipQuery

boolean supportsResourceRelationshipQuery()

Tests if a ResourceRelationshipQuery is available.

Returns:

true if a resource relationship query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceRelationshipQuery

ResourceRelationshipQuery getResourceRelationshipQuery()

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

Returns:

the resource relationship query

Throws:

UnimplementedException - supportsResourceRelationshipQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceRelationshipQuery()} is {@code true} .

matchAnyResourceRelationship

void matchAnyResourceRelationship(boolean match)

Matches resources with any resource relationship.

Parameters:

match - true to match any resource relationship, false to match resources with no relationship

Compliance:

mandatory - This method must be implemented.

clearResourceRelationshipTerms

void clearResourceRelationshipTerms()

Clears the resource relationship terms.

Compliance:

mandatory - This method must be implemented.

matchBinId

void matchBinId(Id binId,
 boolean match)

Sets the bin Id for this query.

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 {@code supportsBinQuery()} is {@code true} .

clearBinTerms

void clearBinTerms()

Clears the bin terms.

Compliance:

mandatory - This method must be implemented.

getResourceQueryRecord

ResourceQueryRecord getResourceQueryRecord(Type resourceRecordType)
                                    throws OperationFailedException

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

Parameters:

resourceRecordType - a resource record type

Returns:

the resource query record

Throws:

NullArgumentException - resourceRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(resourceRecordType) is false

Compliance:

mandatory - This method must be implemented.