OSID Logo
OSID Specifications
topology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.rules.EdgeEnablerSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetEdgeEnablers
Description

Gets the EdgeEnablerList resulting from a search.

Returnosid.topology.rules.EdgeEnablerListthe edge enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablerQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.topology.rules.EdgeEnablerQueryInspectorthe edge enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetEdgeEnablerSearchResultsRecord
Description

Gets the edge enabler search results record corresponding to the given edge enabler search record Type. This method must be used to retrieve an object implementing the requested record.

Parametersosid.type.TypeedgeEnablerSearchRecordTypean edge enabler search record type
Returnosid.topology.rules.records.EdgeEnablerSearchResultsRecordthe edge enabler search results record
ErrorsNULL_ARGUMENT edgeEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(edgeEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.