OSID Logo
OSID Specifications
topology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.GraphQuery
Implementsosid.OsidCatalogQuery
Description

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.

MethodmatchNodeId
Description

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

Parametersosid.id.IdnodeIda node Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT nodeId is null
CompliancemandatoryThis method must be implemented.
MethodclearNodeIdTerms
Description

Clears the node Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsNodeQuery
Description

Tests if a NodeQuery is available.

Returnboolean true if a node query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetNodeQuery
Description

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

Returnosid.topology.NodeQuerythe node query
ErrorsUNIMPLEMENTED supportsNodeQuery() is false
ComplianceoptionalThis method must be implemented if supportsNodeQuery() is true.
MethodmatchAnyNode
Description

Matches graphs that have any node.

Parametersbooleanmatch true to match graphs with any node, false to match graphs with no node
CompliancemandatoryThis method must be implemented.
MethodclearNodeTerms
Description

Clears the node terms.

CompliancemandatoryThis method must be implemented.
MethodmatchEdgeId
Description

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

Parametersosid.id.IdedgeIdthe edge Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT edgeId is null
CompliancemandatoryThis method must be implemented.
MethodclearEdgeIdTerms
Description

Clears the edge Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsEdgeQuery
Description

Tests if an EdgeQuery is available.

Returnboolean true if an edge query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEdgeQuery
Description

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

Returnosid.topology.EdgeQuerythe edge query
ErrorsUNIMPLEMENTED supportsEdgeQuery() is false
ComplianceoptionalThis method must be implemented if supportsEdgeQuery() is true.
MethodmatchAnyEdge
Description

Matches graphs that have any edge.

Parametersbooleanmatch true to match graphs with any edge, false to match graphs with no edge
CompliancemandatoryThis method must be implemented.
MethodclearEdgeTerms
Description

Clears the edge terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorGraphId
Description

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

Parametersosid.id.IdgraphIda graph Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT graphId is null
CompliancemandatoryThis method must be implemented.
MethodclearAncestorGraphIdTerms
Description

Clears the ancestor graph Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorGraphQuery
Description

Tests if a GraphQuery is available.

Returnboolean true if a graph query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAncestorGraphQuery
Description

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

Returnosid.topology.GraphQuerythe graph query
ErrorsUNIMPLEMENTED supportsAncestorGraphQuery() is false
ComplianceoptionalThis method must be implemented if supportsAncestorGraphQuery() is true.
MethodmatchAnyAncestorGraph
Description

Matches graphs with any ancestor.

Parametersbooleanmatch true to match graphs with any ancestor, false to match root graphs
CompliancemandatoryThis method must be implemented.
MethodclearAncestorGraphTerms
Description

Clears the ancestor graph terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantGraphId
Description

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

Parametersosid.id.IdgraphIda graph Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT graphId is null
CompliancemandatoryThis method must be implemented.
MethodclearDescendantGraphIdTerms
Description

Clears the descendant graph Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantGraphQuery
Description

Tests if a GraphQuery is available.

Returnboolean true if a graph query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDescendantGraphQuery
Description

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

Returnosid.topology.GraphQuerythe graph query
ErrorsUNIMPLEMENTED supportsDescendantGraphQuery() is false
ComplianceoptionalThis method must be implemented if supportsDescendantGraphQuery() is true.
MethodmatchAnyDescendantGraph
Description

Matches graphs with any descendant.

Parametersbooleanmatch true to match graphs with any descendant, false to match leaf graphs
CompliancemandatoryThis method must be implemented.
MethodclearDescendantGraphTerms
Description

Clears the descendant graph terms.

CompliancemandatoryThis method must be implemented.
MethodgetGraphQueryRecord
Description

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

Parametersosid.type.TypegraphRecordTypea graph record type
Returnosid.topology.records.GraphQueryRecordthe graph query record
ErrorsNULL_ARGUMENT graphRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(graphRecordType) is false
CompliancemandatoryThis method must be implemented.