public interface GraphSearch extends OsidSearch
The search interface for governing graph searches.
Modifier and Type | Method and Description |
---|---|
GraphSearchRecord |
getGraphSearchRecord(Type graphSearchRecordType)
Gets the graph search record corresponding to the given graph search
record
Type. |
void |
orderGraphResults(GraphSearchOrder graphSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongGraphs(IdList graphIds)
Execute this search among the given list of graphs.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongGraphs(IdList graphIds)
graphIds
- list of graphsNullArgumentException
- graphIds
is
null
mandatory
- This method must be implemented. void orderGraphResults(GraphSearchOrder graphSearchOrder)
graphSearchOrder
- graph search orderNullArgumentException
- graphSearchOrder
is null
UnsupportedException
- graphSearchOrder
is not of this servicemandatory
- This method must be implemented. GraphSearchRecord getGraphSearchRecord(Type graphSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.graphSearchRecordType
- a graph search record typeNullArgumentException
- graphSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(graphSearchRecordType)
is false
mandatory
- This method must be implemented.