public interface TodoProducerSearch extends OsidSearch
The search interface for governing todo producer searches.
Modifier and Type | Method and Description |
---|---|
TodoProducerSearchRecord |
getTodoProducerSearchRecord(Type todoProducerSearchRecordType)
Gets the todo producer search record corresponding to the given todo
producer search record
Type. |
void |
orderTodoProducerResults(TodoProducerSearchOrder todoProducerSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongTodoProducers(IdList todoProducerIds)
Execute this search among the given list of todo producers.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongTodoProducers(IdList todoProducerIds)
todoProducerIds
- list of todo producersNullArgumentException
- todoProducerIds
is null
mandatory
- This method must be implemented. void orderTodoProducerResults(TodoProducerSearchOrder todoProducerSearchOrder)
todoProducerSearchOrder
- todo producer search orderNullArgumentException
- todoProducerSearchOrder
is null
UnsupportedException
- todoProducerSearchOrder
is not of this servicemandatory
- This method must be implemented. TodoProducerSearchRecord getTodoProducerSearchRecord(Type todoProducerSearchRecordType) throws OperationFailedException
Type.
This method is used to
retrieve an object implementing the requested record.todoProducerSearchRecordType
- a todo producer search record
typeNullArgumentException
-
todoProducerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(todoProducerSearchRecordType)
is
false
mandatory
- This method must be implemented.