Interface FileSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface FileSearch
extends OsidSearch

The search interface for governing file searches.

Method Summary

Modifier and Type	Method	Description
FileSearchRecord	getFileSearchRecord(Type fileSearchRecordType)	Gets the file search record corresponding to the given file search record Type .
void	orderFileResults(FileSearchOrder fileSearchOrder)	Specify an ordering to the search results.
void	searchAmongFiles(IdList fileIds)	Execute this search among the given list of files.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongFiles

void searchAmongFiles(IdList fileIds)

Execute this search among the given list of files.

Parameters:

fileIds - list of file Ids

Throws:

NullArgumentException - fileIds is null

Compliance:

mandatory - This method must be implemented.

orderFileResults

void orderFileResults(FileSearchOrder fileSearchOrder)

Specify an ordering to the search results.

Parameters:

fileSearchOrder - file search order

Throws:

NullArgumentException - fileSearchOrder is null

UnsupportedException - fileSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getFileSearchRecord

FileSearchRecord getFileSearchRecord(Type fileSearchRecordType)
                              throws OperationFailedException

Gets the file search 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 record

Throws:

NullArgumentException - fileSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(fileSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.