public interface FrontOfficeSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
FrontOfficeQueryInspector |
getFrontOfficeQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
FrontOfficeList |
getFrontOffices()
Gets the front office list resulting from a search.
|
FrontOfficeSearchResultsRecord |
getFrontOfficeSearchResultsRecord(Type frontOfficeSearchRecordType)
Gets the fromt office search results record corresponding to the given
front office search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
FrontOfficeList getFrontOffices()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. FrontOfficeQueryInspector getFrontOfficeQueryInspector()
mandatory
- This method must be implemented. FrontOfficeSearchResultsRecord getFrontOfficeSearchResultsRecord(Type frontOfficeSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.frontOfficeSearchRecordType
- a front office search record typeNullArgumentException
-
frontOfficeSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(frontOfficeSearchRecordType)
is
false
mandatory
- This method must be implemented.