public interface CookbookSearch extends OsidSearch
The search interface for governing cook book searches.
Modifier and Type | Method and Description |
---|---|
CookbookSearchRecord |
getCookbookSearchRecord(Type cookbookSearchRecordType)
Gets the cook book search record corresponding to the given cook book
search record
Type. |
void |
orderCookbookResults(CookbookSearchOrder cookbooksearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongCookbooks(IdList cookbookIds)
Execute this search among the given list of cook books.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongCookbooks(IdList cookbookIds)
cookbookIds
- list of cook booksNullArgumentException
- cookbookIds
is
null
mandatory
- This method must be implemented. void orderCookbookResults(CookbookSearchOrder cookbooksearchOrder)
cookbooksearchOrder
- cook book search orderNullArgumentException
- cookbooksearchOrder
is null
UnsupportedException
- cookbooksearchOrder
is not of this servicemandatory
- This method must be implemented. CookbookSearchRecord getCookbookSearchRecord(Type cookbookSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record interface.cookbookSearchRecordType
- a cook book search record typeNullArgumentException
- cookbooksearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(cookbooksearchRecordType)
is
false
mandatory
- This method must be implemented.