OSID Logo
OSID Specifications
topology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.NodeQuery
Implementsosid.OsidObjectQuery
Description

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

MethodmatchEdgeId
Description

Sets the edge Id for this query to match nodes that have a related edge.

Parametersosid.id.IdedgeIdan edge Id
booleanmatch true if 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 a 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.
MethodclearEdgeTerms
Description

Clears the edge terms.

CompliancemandatoryThis method must be implemented.
MethodmatchGraphId
Description

Sets the graph Id for this query.

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

Clears the graph Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsGraphQuery
Description

Tests if a GraphQuery is available.

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

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

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

Clears the graph terms.

CompliancemandatoryThis method must be implemented.
MethodgetNodeQueryRecord
Description

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

Parametersosid.type.TypenodeRecordTypea node record type
Returnosid.topology.records.NodeQueryRecordthe node query record
ErrorsNULL_ARGUMENT nodeRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(nodeRecordType) is false
CompliancemandatoryThis method must be implemented.