Interface GraphQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface GraphQuery
extends OsidCatalogQuery

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

Method Summary

Modifier and Type	Method	Description
void	clearAncestorGraphIdTerms()	Clears the ancestor graph Id terms.
void	clearAncestorGraphTerms()	Clears the ancestor graph terms.
void	clearDescendantGraphIdTerms()	Clears the descendant graph Id terms.
void	clearDescendantGraphTerms()	Clears the descendant graph terms.
void	clearEdgeIdTerms()	Clears the edge Id terms.
void	clearEdgeTerms()	Clears the edge terms.
void	clearNodeIdTerms()	Clears the node Id terms.
void	clearNodeTerms()	Clears the node terms.
GraphQuery	getAncestorGraphQuery()	Gets the query for a graph.
GraphQuery	getDescendantGraphQuery()	Gets the query for a graph.
EdgeQuery	getEdgeQuery()	Gets the query for an edge.
GraphQueryRecord	getGraphQueryRecord(Type graphRecordType)	Gets the graph query record corresponding to the given Graph record Type .Multiple record retrievals produce a nested OR term.
NodeQuery	getNodeQuery()	Gets the query for a node.
void	matchAncestorGraphId(Id graphId, boolean match)	Sets the graph Id for this query to match graphs that have the specified graph as an ancestor.
void	matchAnyAncestorGraph(boolean match)	Matches graphs with any ancestor.
void	matchAnyDescendantGraph(boolean match)	Matches graphs with any descendant.
void	matchAnyEdge(boolean match)	Matches graphs that have any edge.
void	matchAnyNode(boolean match)	Matches graphs that have any node.
void	matchDescendantGraphId(Id graphId, boolean match)	Sets the graph Id for this query to match graphs that have the specified graph as a descendant.
void	matchEdgeId(Id edgeId, boolean match)	Sets the edge Id for this query to match graphs containing edges.
void	matchNodeId(Id nodeId, boolean match)	Sets the node Id for this query to match graphs that have a related node.
boolean	supportsAncestorGraphQuery()	Tests if a GraphQuery is available.
boolean	supportsDescendantGraphQuery()	Tests if a GraphQuery is available.
boolean	supportsEdgeQuery()	Tests if an EdgeQuery is available.
boolean	supportsNodeQuery()	Tests if a NodeQuery 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.

Methods inherited from interface OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

matchNodeId

void matchNodeId(Id nodeId,
 boolean match)

Sets the node Id for this query to match graphs that have a related node.

Parameters:

nodeId - a node Id

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

Throws:

NullArgumentException - nodeId is null

Compliance:

mandatory - This method must be implemented.

clearNodeIdTerms

void clearNodeIdTerms()

Clears the node Id terms.

Compliance:

mandatory - This method must be implemented.

supportsNodeQuery

boolean supportsNodeQuery()

Tests if a NodeQuery is available.

Returns:

true if a node query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getNodeQuery

NodeQuery getNodeQuery()

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

Returns:

the node query

Throws:

UnimplementedException - supportsNodeQuery() is false

Compliance:

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

matchAnyNode

void matchAnyNode(boolean match)

Matches graphs that have any node.

Parameters:

match - true to match graphs with any node, false to match graphs with no node

Compliance:

mandatory - This method must be implemented.

clearNodeTerms

void clearNodeTerms()

Clears the node terms.

Compliance:

mandatory - This method must be implemented.

matchEdgeId

void matchEdgeId(Id edgeId,
 boolean match)

Sets the edge Id for this query to match graphs containing edges.

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.

clearEdgeIdTerms

void clearEdgeIdTerms()

Clears the edge Id terms.

Compliance:

mandatory - This method must be implemented.

supportsEdgeQuery

boolean supportsEdgeQuery()

Tests if an EdgeQuery is available.

Returns:

true if an edge query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEdgeQuery

EdgeQuery getEdgeQuery()

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

Returns:

the edge query

Throws:

UnimplementedException - supportsEdgeQuery() is false

Compliance:

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

matchAnyEdge

void matchAnyEdge(boolean match)

Matches graphs that have any edge.

Parameters:

match - true to match graphs with any edge, false to match graphs with no edge

Compliance:

mandatory - This method must be implemented.

clearEdgeTerms

void clearEdgeTerms()

Clears the edge terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorGraphId

void matchAncestorGraphId(Id graphId,
 boolean match)

Sets the graph Id for this query to match graphs that have the specified graph as an ancestor.

Parameters:

graphId - a 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.

clearAncestorGraphIdTerms

void clearAncestorGraphIdTerms()

Clears the ancestor graph Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorGraphQuery

boolean supportsAncestorGraphQuery()

Tests if a GraphQuery is available.

Returns:

true if a graph query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorGraphQuery

GraphQuery getAncestorGraphQuery()

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

Returns:

the graph query

Throws:

UnimplementedException - supportsAncestorGraphQuery() is false

Compliance:

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

matchAnyAncestorGraph

void matchAnyAncestorGraph(boolean match)

Matches graphs with any ancestor.

Parameters:

match - true to match graphs with any ancestor, false to match root graphs

Compliance:

mandatory - This method must be implemented.

clearAncestorGraphTerms

void clearAncestorGraphTerms()

Clears the ancestor graph terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantGraphId

void matchDescendantGraphId(Id graphId,
 boolean match)

Sets the graph Id for this query to match graphs that have the specified graph as a descendant.

Parameters:

graphId - a 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.

clearDescendantGraphIdTerms

void clearDescendantGraphIdTerms()

Clears the descendant graph Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantGraphQuery

boolean supportsDescendantGraphQuery()

Tests if a GraphQuery is available.

Returns:

true if a graph query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantGraphQuery

GraphQuery getDescendantGraphQuery()

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

Returns:

the graph query

Throws:

UnimplementedException - supportsDescendantGraphQuery() is false

Compliance:

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

matchAnyDescendantGraph

void matchAnyDescendantGraph(boolean match)

Matches graphs with any descendant.

Parameters:

match - true to match graphs with any descendant, false to match leaf graphs

Compliance:

mandatory - This method must be implemented.

clearDescendantGraphTerms

void clearDescendantGraphTerms()

Clears the descendant graph terms.

Compliance:

mandatory - This method must be implemented.

getGraphQueryRecord

GraphQueryRecord getGraphQueryRecord(Type graphRecordType)
                              throws OperationFailedException

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

Parameters:

graphRecordType - a graph record type

Returns:

the graph query record

Throws:

NullArgumentException - graphRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(graphRecordType) is false

Compliance:

mandatory - This method must be implemented.