public interface OfferingSearch extends OsidSearch
The search interface for governing offering searches.
Modifier and Type | Method and Description |
---|---|
OfferingSearchRecord |
getOfferingSearchRecord(Type offeringSearchRecordType)
Gets the record corresponding to the given offering search record
Type. |
void |
orderOfferingResults(OfferingSearchOrder offeringSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongOfferings(IdList offeringIds)
Execute this search among the given list of offerings.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongOfferings(IdList offeringIds)
offeringIds
- list of offeringsNullArgumentException
- offeringIds
is
null
mandatory
- This method must be implemented. void orderOfferingResults(OfferingSearchOrder offeringSearchOrder)
offeringSearchOrder
- offering search orderNullArgumentException
- offeringSearchOrder
is null
UnsupportedException
- offeringSearchOrder
is not of this servicemandatory
- This method must be implemented. OfferingSearchRecord getOfferingSearchRecord(Type offeringSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.offeringSearchRecordType
- an offering search record typeNullArgumentException
- offeringSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(offeringSearchRecordType)
is
false
mandatory
- This method must be implemented.