public interface RelationshipSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
RelationshipQueryInspector |
getRelationshipQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
RelationshipList |
getRelationships()
Gets the relationship list resulting from a search.
|
RelationshipSearchResultsRecord |
getRelationshipSearchResultsRecord(Type relationshipSearchRecordType)
Gets the relationship search results record corresponding to the given
relationship search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
RelationshipList getRelationships()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. RelationshipQueryInspector getRelationshipQueryInspector()
mandatory
- This method must be implemented. RelationshipSearchResultsRecord getRelationshipSearchResultsRecord(Type relationshipSearchRecordType) throws OperationFailedException, PermissionDeniedException
Type.
This method must be
used to retrieve an object implementing the requested record interface
along with all of its ancestor interfaces.relationshipSearchRecordType
- a relationship search record typeNullArgumentException
-
relationshipSearchRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(relationshipSearchRecordType)
is
false
mandatory
- This method must be implemented.