Interface FileSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface FileSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
FileQueryInspector	getFileQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
FileList	getFiles()	Gets the file list resulting from a search.
FileSearchResultsRecord	getFileSearchResultsRecord(Type fileSearchRecordType)	Gets the file search results record corresponding to the given file 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

getFiles

FileList getFiles()

Gets the file list resulting from a search.

Returns:

the directory list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getFileQueryInspector

FileQueryInspector getFileQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getFileSearchResultsRecord

FileSearchResultsRecord getFileSearchResultsRecord(Type fileSearchRecordType)
                                            throws OperationFailedException

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

Parameters:

fileSearchRecordType - a file search record type

Returns:

the file search results record

Throws:

NullArgumentException - fileSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(fileSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.