public interface NodeSearch extends OsidSearch
The search interface for governing node searches.
Modifier and Type | Method and Description |
---|---|
NodeSearchRecord |
getNodeSearchRecord(Type nodeSearchRecordType)
Gets the node search record corresponding to the given node search
record
Type. |
void |
orderNodeResults(NodeSearchOrder nodeSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongNodes(IdList nodeIds)
Execute this search among the given list of nodes.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongNodes(IdList nodeIds)
nodeIds
- list of nodesNullArgumentException
- nodeIds
is
null
mandatory
- This method must be implemented. void orderNodeResults(NodeSearchOrder nodeSearchOrder)
nodeSearchOrder
- node search orderNullArgumentException
- nodeSearchOrder
is null
UnsupportedException
- nodeSearchOrder
is not of this servicemandatory
- This method must be implemented. NodeSearchRecord getNodeSearchRecord(Type nodeSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.nodeSearchRecordType
- a node search record typeNullArgumentException
- nodeSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(nodeSearchRecordType)
is false
mandatory
- This method must be implemented.