public interface FunctionSearch extends OsidSearch
FunctionSearch
defines the interface for specifying
function search options.
Modifier and Type | Method and Description |
---|---|
FunctionSearchRecord |
getFunctionSearchRecord(Type functionSearchRecordType)
Gets the function search record corresponding to the given function
search record
Type. |
void |
orderFunctionResults(FunctionSearchOrder functionSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongFunctions(IdList functionIds)
Execute this search among the given list of functions.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongFunctions(IdList functionIds)
functionIds
- list of functionsNullArgumentException
- functionIds
is
null
mandatory
- This method must be implemented. void orderFunctionResults(FunctionSearchOrder functionSearchOrder)
functionSearchOrder
- function search orderNullArgumentException
- functionSearchOrder
is null
UnsupportedException
- functionSearchOrder
is not of this servicemandatory
- This method must be implemented. FunctionSearchRecord getFunctionSearchRecord(Type functionSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.functionSearchRecordType
- a function search record typeNullArgumentException
- functionSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(functionSearchRecordType)
is
false
mandatory
- This method must be implemented.