public interface FileSearch extends OsidSearch
The search interface for governing file searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongFiles(IdList fileIds)
fileIds
- list of file Ids
NullArgumentException
- fileIds
is
null
mandatory
- This method must be implemented. void orderFileResults(FileSearchOrder fileSearchOrder)
fileSearchOrder
- file search orderNullArgumentException
- fileSearchOrder
is null
UnsupportedException
- fileSearchOrder
is not of this servicemandatory
- This method must be implemented. FileSearchRecord getFileSearchRecord(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.