OSID Logo
OSID Specifications
authorization package
Version 3.1.0
Interfaceosid.authorization.VaultSearchResults
Implementsosid.OsidSearchResults
Used Byosid.authorization.VaultSearchSession
Description

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

MethodgetVaults
Description

Gets the vault list resulting from the search.

Returnosid.authorization.VaultList the vault list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetVaultQueryInspector
Description

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

Returnosid.authorization.VaultQueryInspector the vault query inspector
Compliancemandatory This method must be implemented.
MethodgetVaultSearchResultsRecord
Description

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

Parametersosid.type.TypevaultSearchRecordType a vault search record type
Returnosid.authorization.records.VaultSearchResultsRecord the vault search results record
ErrorsNULL_ARGUMENT vaultSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(vaultSearchRecordType) is false
Compliancemandatory This method must be implemented.