public interface ConvocationSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
ConvocationQueryInspector |
getConvocationQueryInspector()
Gets the inspector for the query to examine the terns used in the
search.
|
ConvocationList |
getConvocations()
Gets the convocation list resulting from a search.
|
ConvocationSearchResultsRecord |
getConvocationSearchResultsRecord(Type convocationSearchRecordType)
Gets the convocation search results record corresponding to the given
convocation search record Type.
|
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
ConvocationList getConvocations()
IllegalStateException
- list has already been retrievedmandatory
- This method must be implemented. ConvocationQueryInspector getConvocationQueryInspector()
mandatory
- This method must be implemented. ConvocationSearchResultsRecord getConvocationSearchResultsRecord(Type convocationSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.convocationSearchRecordType
- a convocation search record typeNullArgumentException
-
convocationSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(convocationSearchRecordType)
is
false
mandatory
- This method must be implemented.