public interface CommitmentSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
CommitmentQueryInspector |
getCommitmentQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
CommitmentList |
getCommitments()
Gets the commitment list resulting from the search.
|
CommitmentSearchResultsRecord |
getCommitmentSearchResultsRecord(Type commitmentSearchRecordType)
Gets the commitment search results record corresponding to the given
commitment search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
CommitmentList getCommitments()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. CommitmentQueryInspector getCommitmentQueryInspector()
mandatory
- This method must be implemented. CommitmentSearchResultsRecord getCommitmentSearchResultsRecord(Type commitmentSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.commitmentSearchRecordType
- a commitment search record typeNullArgumentException
-
commitmentSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(commitmentSearchRecordType)
is
false
mandatory
- This method must be implemented.