OSID Logo
OSID Specifications
topology path package
Version 3.0.0
Interfaceosid.topology.path.PathSearch
Implementsosid.OsidSearch
Used Byosid.topology.path.PathSearchSession
Description

The search interface for governing path searches.

MethodsearchAmongPaths
Description

Execute this search among the given list of paths.

Parametersosid.id.IdListpathIdslist of paths
ErrorsNULL_ARGUMENTpathIds is null
CompliancemandatoryThis method must be implemented.
MethodorderPathResults
Description

Specify an ordering to the search results.

Parametersosid.topology.path.PathSearchOrderpathSearchOrderpath search order
ErrorsNULL_ARGUMENTpathSearchOrder is null
UNSUPPORTEDpathSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPathSearchRecord
Description

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

Parametersosid.type.TypepathSearchRecordTypea path search record type
Returnosid.topology.path.records.PathSearchRecordthe path search record
ErrorsNULL_ARGUMENTpathSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(pathSearchRecordType) is false
CompliancemandatoryThis method must be implemented.