public interface CreditSearch extends OsidSearch
The search interface for governing credit searches.
Modifier and Type | Method and Description |
---|---|
CreditSearchRecord |
getCreditSearchRecord(Type creditSearchRecordType)
Gets the record corresponding to the given credit search record
Type. |
void |
orderCreditResults(CreditSearchOrder creditSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCredits(IdList creditIds)
Execute this search among the given list of credits.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCredits(IdList creditIds)
creditIds
- list of creditsNullArgumentException
- creditIds
is
null
mandatory
- This method must be implemented. void orderCreditResults(CreditSearchOrder creditSearchOrder)
creditSearchOrder
- credit search orderNullArgumentException
- creditSearchOrder
is null
UnsupportedException
- creditSearchOrder
is not of this servicemandatory
- This method must be implemented. CreditSearchRecord getCreditSearchRecord(Type creditSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object implementing
the requested record.creditSearchRecordType
- a credit search record typeNullArgumentException
- creditSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(creditSearchRecordType)
is false
mandatory
- This method must be implemented.