public interface CatalogEnablerSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
CatalogEnablerQueryInspector |
getCatalogEnablerQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
CatalogEnablerList |
getCatalogEnablers()
Gets the
CatalogEnablerList resulting from a search. |
CatalogEnablerSearchResultsRecord |
getCatalogEnablerSearchResultsRecord(Type catalogEnablerSearchRecordType)
Gets the catalog enabler search results record corresponding to the
given catalog enabler search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
CatalogEnablerList getCatalogEnablers()
CatalogEnablerList
resulting from a search.IllegalStateException
- list has already been retrievedmandatory
- This method must be implemented. CatalogEnablerQueryInspector getCatalogEnablerQueryInspector()
mandatory
- This method must be implemented. CatalogEnablerSearchResultsRecord getCatalogEnablerSearchResultsRecord(Type catalogEnablerSearchRecordType) throws OperationFailedException, PermissionDeniedException
Type.
This method
must be used to retrieve an object implementing the requested record.catalogEnablerSearchRecordType
- a catalog enabler search record
typeNullArgumentException
-
catalogEnablerSearchRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(catalogEnablerSearchRecordType)
is
false
mandatory
- This method must be implemented.