public interface RelationshipEnablerSearchSession extends RelationshipEnablerQuerySession
This session provides methods for searching among
RelationshipEnabler
objects. The search query is constructed using
the RelationshipEnableryQuery.
getRelationshipEnablersByQuery()
is the basic search
method and returns a list of RelationshipEnablers.
A more
advanced search may be performed with
getRelationshipEnablersBySearch().
It accepts a
RelationshipEnablerSearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getRelationshipEnablersBySearch()
returns a
RelationshipEnablerSearchResults
that can be used to access
the resulting RelationshipEnablerList
or be used to perform
a search within the result set through RelationshipEnablerSearch.
This session defines views that offer differing behaviors for searching.
RelationshipEnablers
may have a query record indicated
by their respective record types. The query record is accessed via the
RelationshipEnablerQuery.
Modifier and Type | Method and Description |
---|---|
RelationshipEnablerQuery |
getRelationshipEnablerQueryFromInspector(RelationshipEnablerQueryInspector relationshipEnablerQueryInspector)
Gets a relationship enabler query from an inspector.
|
RelationshipEnablerSearchResults |
getRelationshipEnablersBySearch(RelationshipEnablerQuery relationshipEnablerQuery,
RelationshipEnablerSearch relationshipEnablerSearch)
Gets the search results matching the given search query using the
given search.
|
RelationshipEnablerSearch |
getRelationshipEnablerSearch()
Gets a relationship enabler search.
|
RelationshipEnablerSearchOrder |
getRelationshipEnablerSearchOrder()
Gets a relationship enabler search order.
|
canSearchRelationshipEnablers, getFamily, getFamilyId, getRelationshipEnablerQuery, getRelationshipEnablersByQuery, useFederatedFamilyView, useIsolatedFamilyView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
RelationshipEnablerSearch getRelationshipEnablerSearch()
mandatory
- This method must be implemented. RelationshipEnablerSearchOrder getRelationshipEnablerSearchOrder()
RelationshipEnablerSearchOrder
is supplied to a
RelationshipEnablerSearch
to specify the ordering of results.mandatory
- This method must be implemented. RelationshipEnablerSearchResults getRelationshipEnablersBySearch(RelationshipEnablerQuery relationshipEnablerQuery, RelationshipEnablerSearch relationshipEnablerSearch) throws OperationFailedException, PermissionDeniedException
relationshipEnablerQuery
- the relationship enabler queryrelationshipEnablerSearch
- the relationship enabler searchNullArgumentException
- relationshipEnablerQuery
or relationshipEnablerSearch
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- relationshipEnablerQuery
or relationshipEnablerSearch
is not of
this servicemandatory
- This method must be implemented. RelationshipEnablerQuery getRelationshipEnablerQueryFromInspector(RelationshipEnablerQueryInspector relationshipEnablerQueryInspector)
RelationshipEnablerSearchResults.
relationshipEnablerQueryInspector
- a relationship enabler query
inspectorNullArgumentException
-
relationshipEnablerQueryInspector
is null
UnsupportedException
-
relationshipEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.