public interface EdgeSearch extends OsidSearch
The search interface for governing edge searches.
Modifier and Type | Method and Description |
---|---|
EdgeSearchRecord |
getEdgeSearchRecord(Type edgeSearchRecordType)
Gets the edge search record corresponding to the given edge search
record
Type. |
void |
orderEdgeResults(EdgeSearchOrder edgeSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongEdges(IdList edgeIds)
Execute this search among the given list of edges.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongEdges(IdList edgeIds)
edgeIds
- list of edgesNullArgumentException
- edgeIds
is
null
mandatory
- This method must be implemented. void orderEdgeResults(EdgeSearchOrder edgeSearchOrder)
edgeSearchOrder
- edge search orderNullArgumentException
- edgeSearchOrder
is null
UnsupportedException
- edgeSearchOrder
is not of this servicemandatory
- This method must be implemented. EdgeSearchRecord getEdgeSearchRecord(Type edgeSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.edgeSearchRecordType
- a edge search record typeNullArgumentException
- edgeSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(edgeSearchRecordType)
is false
mandatory
- This method must be implemented.