public interface DistributorSearch extends OsidSearch
The search interface for governing distributor searches.
Modifier and Type | Method and Description |
---|---|
DistributorSearchRecord |
getDistributorSearchRecord(Type distributorSearchRecordType)
Gets the distributor search record corresponding to the given
distributor search record
Type. |
void |
orderDistributorResults(DistributorSearchOrder distributorSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongDistributors(IdList distributorIds)
Execute this search among the given list of distributors.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongDistributors(IdList distributorIds)
distributorIds
- list of distributorsNullArgumentException
- distributorIds
is null
mandatory
- This method must be implemented. void orderDistributorResults(DistributorSearchOrder distributorSearchOrder)
distributorSearchOrder
- distributor search orderNullArgumentException
- distributorSearchOrder
is null
UnsupportedException
- distributorSearchOrder
is not of this servicemandatory
- This method must be implemented. DistributorSearchRecord getDistributorSearchRecord(Type distributorSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.distributorSearchRecordType
- a distributor search record typeNullArgumentException
-
distributorSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(distributorSearchRecordType)
is
false
mandatory
- This method must be implemented.