public interface RelationshipSearch extends OsidSearch
The search interface for governing relationship searches.
Modifier and Type | Method and Description |
---|---|
RelationshipSearchRecord |
getRelationshipSearchRecord(Type relationshipSearchRecordType)
Gets the relationship search record corresponding to the given
relationship search record
Type. |
void |
orderRelationshipResults(RelationshipSearchOrder relationshipSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongRelationships(IdList relationshipIds)
Execute this search among the given list of relationships.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongRelationships(IdList relationshipIds)
relationshipIds
- list of relationshipsNullArgumentException
- relationshipIds
is null
mandatory
- This method must be implemented. void orderRelationshipResults(RelationshipSearchOrder relationshipSearchOrder)
relationshipSearchOrder
- relationship search orderNullArgumentException
- relationshipSearchOrder
is null
UnsupportedException
- relationshipSearchOrder
is not of this servicemandatory
- This method must be implemented. RelationshipSearchRecord getRelationshipSearchRecord(Type relationshipSearchRecordType) throws OperationFailedException, PermissionDeniedException
Type.
This method is used to
retrieve an object implementing the requested record.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.