public interface RelationshipSearchSession extends RelationshipQuerySession
This session provides methods for searching among Relationship
objects. The search query is constructed using the
Relationship.
getRelationshipsByQuery()
is the basic search method
and returns a list of Relationships.
A more advanced search
may be performed with getRelationshipsBySearch().
It
accepts a RelationshipSearch
in addition to the query for
the purpose of specifying additional options affecting the entire search,
such as ordering. getRelationshipsBySearch()
returns a
RelationshipSearchResults
that can be used to access the
resulting RelationshipList
or be used to perform a search
within the result set through RelationshipSearch.
Relationships may have a query record indicated by their respective
record types. The query record is accessed via the
RelationshipQuery.
Modifier and Type | Method and Description |
---|---|
RelationshipQuery |
getRelationshipQueryFromInspector(RelationshipQueryInspector relationshipQueryInspector)
Gets a relationship query from an inspector.
|
RelationshipSearchResults |
getRelationshipsBySearch(RelationshipQuery relationshipQuery,
RelationshipSearch relationshipSearch)
Gets the search results matching the given search query using the
given search.
|
RelationshipSearch |
getRelationshipSearch()
Gets a relationship search.
|
RelationshipSearchOrder |
getRelationshipSearchOrder()
Gets a relationship search order.
|
canSearchRelationships, getFamily, getFamilyId, getRelationshipQuery, getRelationshipsByQuery, useFederatedFamilyView, useIsolatedFamilyView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
RelationshipSearch getRelationshipSearch()
mandatory
- This method must be implemented. RelationshipSearchOrder getRelationshipSearchOrder()
RelationshipSearchOrder
is supplied to a RelationshipSearch
to specify
the ordering of results.mandatory
- This method must be implemented. RelationshipSearchResults getRelationshipsBySearch(RelationshipQuery relationshipQuery, RelationshipSearch relationshipSearch) throws OperationFailedException, PermissionDeniedException
relationshipQuery
- the relationship queryrelationshipSearch
- the relationship searchNullArgumentException
- relationshipQuery
or relationshipSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- relationshipQuery
or relationshipSearch
is not of this servicemandatory
- This method must be implemented. RelationshipQuery getRelationshipQueryFromInspector(RelationshipQueryInspector relationshipQueryInspector)
RelationshipSearchResults.
relationshipQueryInspector
- a relationship query inspectorNullArgumentException
-
relationshipQueryInspector
is null
UnsupportedException
-
relationshipQueryInspector
is not of this servicemandatory
- This method must be implemented.