public interface CommissionSearch extends OsidSearch
The search interface for governing commission searches.
Modifier and Type | Method and Description |
---|---|
CommissionSearchRecord |
getCommissionSearchRecord(Type commissionSearchRecordType)
Gets the commission search record corresponding to the given
commission search record
Type. |
void |
orderCommissionResults(CommissionSearchOrder commissionSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCommissions(IdList commissionIds)
Execute this search among the given list of commissions.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCommissions(IdList commissionIds)
commissionIds
- list of commissionsNullArgumentException
- commissionIds
is
null
mandatory
- This method must be implemented. void orderCommissionResults(CommissionSearchOrder commissionSearchOrder)
commissionSearchOrder
- commission search orderNullArgumentException
- commissionSearchOrder
is null
UnsupportedException
- commissionSearchOrder
is not of this servicemandatory
- This method must be implemented. CommissionSearchRecord getCommissionSearchRecord(Type commissionSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.commissionSearchRecordType
- a commission search record typeNullArgumentException
-
commissionSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(commissionSearchRecordType)
is
false
mandatory
- This method must be implemented.