public interface ProfileItemSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
ProfileItemQueryInspector |
getProfileItemQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
ProfileItemList |
getProfileItems()
Gets the profile item list resulting from the search.
|
ProfileItemSearchResultsRecord |
getProfileItemSearchResultsRecord(Type profileItemSearchRecordType)
Gets the profile search results record corresponding to the given
profile item search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
ProfileItemList getProfileItems()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. ProfileItemQueryInspector getProfileItemQueryInspector()
mandatory
- This method must be implemented. ProfileItemSearchResultsRecord getProfileItemSearchResultsRecord(Type profileItemSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.profileItemSearchRecordType
- a profile item search record typeNullArgumentException
-
profileItemSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(profileItemSearchRecordType)
is
false
mandatory
- This method must be implemented.