OSID Logo
OSID Specifications
topology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.EdgeSearch
Implementsosid.OsidSearch
Description

The search interface for governing edge searches.

MethodsearchAmongEdges
Description

Execute this search among the given list of edges.

Parametersosid.id.IdListedgeIdslist of edges
ErrorsNULL_ARGUMENT edgeIds is null
CompliancemandatoryThis method must be implemented.
MethodorderEdgeResults
Description

Specify an ordering to the search results.

Parametersosid.topology.EdgeSearchOrderedgeSearchOrderedge search order
ErrorsNULL_ARGUMENT edgeSearchOrder is null
UNSUPPORTED edgeSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetEdgeSearchRecord
Description

Gets the edge search record corresponding to the given edge search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeedgeSearchRecordTypea edge search record type
Returnosid.topology.records.EdgeSearchRecordthe edge search record
ErrorsNULL_ARGUMENT edgeSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(edgeSearchRecordType) is false
CompliancemandatoryThis method must be implemented.