PaymentSearchResults

All Superinterfaces:: Browsable, Extensible, OsidResult, OsidSearchResults

public interface PaymentSearchResults extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type

Method

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.This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable
getProperties, getPropertiesByRecordType

Methods inherited from interface Extensible
getRecordTypes, hasRecordType

Methods inherited from interface OsidSearchResults
getResultSize

Method Details
- getPayments
  
  PaymentList getPayments()
  
  Gets the payment list resulting from a search.
  
  Returns:
  
  the payment list
  
  Throws:
  
  IllegalStateException - the payment list has already been retrieved
  
  Compliance:
  mandatory - This method must be implemented.
- getPaymentQueryInspector
  
  PaymentQueryInspector getPaymentQueryInspector()
  
  Gets the inspector for the query to examine the periods used in the search.
  
  Returns:
  
  the query inspector
  
  Compliance:
  mandatory - This method must be implemented.
- getPaymentSearchResultsRecord
  
  PaymentSearchResultsRecord getPaymentSearchResultsRecord(Type paymentSearchRecordType) throws OperationFailedException
  
  Gets the payment search results record corresponding to the given payment search record Type.This method is used to retrieve an object implementing the requested record.
  
  Parameters:
  
  paymentSearchRecordType - a payment search record type
  
  Returns:
  
  the payment search results record
  
  Throws:
  
  NullArgumentException - paymentSearchRecordType is null
  
  OperationFailedException - unable to complete request
  
  UnsupportedException - hasRecordType(paymentSearchRecordType) is false
  
  Compliance:
  mandatory - This method must be implemented.