OSID Logo
OSID Specifications
topology path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.path.PathSearch
Implementsosid.OsidSearch
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_ARGUMENT pathIds is null
CompliancemandatoryThis method must be implemented.
MethodorderPathResults
Description

Specify an ordering to the search results.

Parametersosid.topology.path.PathSearchOrderpathSearchOrderpath search order
ErrorsNULL_ARGUMENT pathSearchOrder is null
UNSUPPORTED pathSearchOrder 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_ARGUMENT pathSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(pathSearchRecordType) is false
CompliancemandatoryThis method must be implemented.