OSID Logo
OSID Specifications
topology package
Version 3.1.0
Interfaceosid.topology.EdgeSearch
Implementsosid.OsidSearch
Used Byosid.topology.EdgeSearchSession
Description

The search interface for governing edge searches.

MethodsearchAmongEdges
Description

Execute this search among the given list of edges.

Parametersosid.id.IdListedgeIds list of edges
ErrorsNULL_ARGUMENT edgeIds is null
Compliancemandatory This method must be implemented.
MethodorderEdgeResults
Description

Specify an ordering to the search results.

Parametersosid.topology.EdgeSearchOrderedgeSearchOrder edge search order
ErrorsNULL_ARGUMENT edgeSearchOrder is null
UNSUPPORTED edgeSearchOrder is not of this service
Compliancemandatory This 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.TypeedgeSearchRecordType an edge search record type
Returnosid.topology.records.EdgeSearchRecord the edge search record
ErrorsNULL_ARGUMENT edgeSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(edgeSearchRecordType) is false
Compliancemandatory This method must be implemented.