OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.SystemSearch
Implementsosid.OsidSearch
Description

The search interface for governing system searches.

MethodsearchAmongSystems
Description

Execute this search among the given list of systems.

Parametersosid.id.IdListsystemIdslist of systems
ErrorsNULL_ARGUMENT systemIds is null
CompliancemandatoryThis method must be implemented.
MethodorderSystemResults
Description

Specify an ordering to the search results.

Parametersosid.control.SystemSearchOrdersystemSearchOrdersystem search order
ErrorsNULL_ARGUMENT systemSearchOrder is null
UNSUPPORTED systemSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSystemSearchRecord
Description

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

Parametersosid.type.TypesystemSearchRecordTypea system search record type
Returnosid.control.records.SystemSearchRecordthe system search record
ErrorsNULL_ARGUMENT systemSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(systemSearchRecordType) is false
CompliancemandatoryThis method must be implemented.