OSID Logo
OSID Specifications
topology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.rules.EdgeEnablerQuery
Implementsosid.OsidEnablerQuery
Description

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

MethodmatchRuledEdgeId
Description

Matches enablers mapped to the edge.

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.
MethodclearRuledEdgeIdTerms
Description

Clears the edge Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledEdgeQuery
Description

Tests if an EdgeQuery is available.

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

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

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

Matches enablers mapped to any edge.

Parametersbooleanmatch true for enablers mapped to any edge, false to match enablers mapped to no edge
CompliancemandatoryThis method must be implemented.
MethodclearRuledEdgeTerms
Description

Clears the edge query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchGraphId
Description

Matches enablers mapped to the graph.

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 query 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 query terms.

CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablerQueryRecord
Description

Gets the edge enabler query record corresponding to the given EdgeEnabler record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeedgeEnablerRecordTypean edge enabler record type
Returnosid.topology.rules.records.EdgeEnablerQueryRecordthe edge enabler query record
ErrorsNULL_ARGUMENT edgeEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(edgeEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.