public interface PaymentSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
PaymentQueryInspector |
getPaymentQueryInspector()
Gets the inspector for the query to examine the periods used in the
search.
|
PaymentList |
getPayments()
Gets the payment list resulting from a search.
|
PaymentSearchResultsRecord |
getPaymentSearchResultsRecord(Type paymentSearchRecordType)
Gets the payment search results record corresponding to the given
payment search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
PaymentList getPayments()
IllegalStateException
- the payment list has already
been retrievedmandatory
- This method must be implemented. PaymentQueryInspector getPaymentQueryInspector()
mandatory
- This method must be implemented. PaymentSearchResultsRecord getPaymentSearchResultsRecord(Type paymentSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.paymentSearchRecordType
- a payment search record typeNullArgumentException
- paymentSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(paymentSearchRecordType)
is false
mandatory
- This method must be implemented.