public interface WorkSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
WorkQueryInspector |
getWorkQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
WorkList |
getWorks()
Gets the work list resulting from a search.
|
WorkSearchResultsRecord |
getWorkSearchResultsRecord(Type workSearchRecordType)
Gets the work search results record corresponding to the given work
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
WorkList getWorks()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. WorkQueryInspector getWorkQueryInspector()
mandatory
- This method must be implemented. WorkSearchResultsRecord getWorkSearchResultsRecord(Type workSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.workSearchRecordType
- a work search record typeNullArgumentException
- workSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(workSearchRecordType)
is false
mandatory
- This method must be implemented.