public interface FileSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and 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. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
FileList getFiles()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. FileQueryInspector getFileQueryInspector()
mandatory
- This method must be implemented. FileSearchResultsRecord getFileSearchResultsRecord(Type fileSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.fileSearchRecordType
- a file search record typeNullArgumentException
- fileSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(fileSearchRecordType)
is false
mandatory
- This method must be implemented.