Interface VaultSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface VaultSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
VaultQueryInspector	getVaultQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
VaultList	getVaults()	Gets the vault list resulting from the search.
VaultSearchResultsRecord	getVaultSearchResultsRecord(Type vaultSearchRecordType)	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.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getVaults

VaultList getVaults()

Gets the vault list resulting from the search.

Returns:

the vault list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getVaultQueryInspector

VaultQueryInspector getVaultQueryInspector()

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

Returns:

the vault query inspector

Compliance:

mandatory - This method must be implemented.

getVaultSearchResultsRecord

VaultSearchResultsRecord getVaultSearchResultsRecord(Type vaultSearchRecordType)
                                              throws OperationFailedException

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.

Parameters:

vaultSearchRecordType - a vault search record type

Returns:

the vault search results record

Throws:

NullArgumentException - vaultSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(vaultSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.