public interface ResourceRelationshipSearchSession extends ResourceRelationshipQuerySession
This session provides methods for searching ResourceRelationship
objects. The search query is constructed using the
ResourceRelationshipQuery.
The resource relationship record
Type
also specifies the record for the relationship query.
getResourceRelationshipsByQuery()
is the basic search
method and returns a list of ResourceRelationships.
A more
advanced search may be performed with
getResourceRelationshipsBySearch().
It accepts a
ResourceRelationshipSearch
in addition to the query for the
purpose of specifying additional options affecting the entire search, such
as ordering. getResourceRelationshipsBySearch()
returns an
ResourceRelationshipSearchResults
that can be used to
access the resulting ResourceRelationshipList
or be used to
perform a search within the result set through
ResourceRelationshipSearch.
This session defines views that offer differing behaviors for searching.
Relationships may have a resource relationship query record indicated
by their respective record types. The resource relationship query record
is accessed via the ResourceRelationshipQuery.
Modifier and Type | Method and Description |
---|---|
ResourceRelationshipQuery |
getResourceRelationshipQueryFromInspector(ResourceRelationshipQueryInspector resourceRelationshipQueryInspector)
Gets a resource relationship query from an inspector.
|
ResourceRelationshipSearchResults |
getResourceRelationshipsBySearch(ResourceRelationshipQuery resourceRelationshipQuery,
ResourceRelationshipSearch resourceRelationshipSearch)
Gets the search results matching the given search query using the
given search.
|
ResourceRelationshipSearch |
getResourceRelationshipSearch()
Gets a relationship search.
|
ResourceRelationshipSearchOrder |
getResourceRelationshipSearchOrder()
Gets a relationship search order.
|
canSearchResourceRelationships, getBin, getBinId, getResourceRelationshipQuery, getResourceRelationshipsByQuery, useFederatedBinView, useIsolatedBinView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ResourceRelationshipSearch getResourceRelationshipSearch()
mandatory
- This method must be implemented. ResourceRelationshipSearchOrder getResourceRelationshipSearchOrder()
ResourceRelationshipSearchOrder
is supplied to a
ResourceRelationshipSearch
to specify the ordering of results.mandatory
- This method must be implemented. ResourceRelationshipSearchResults getResourceRelationshipsBySearch(ResourceRelationshipQuery resourceRelationshipQuery, ResourceRelationshipSearch resourceRelationshipSearch) throws OperationFailedException, PermissionDeniedException
resourceRelationshipQuery
- the resource relationship queryresourceRelationshipSearch
- the resource relationship searchNullArgumentException
-
resourceRelationshipQuery
or r
esourceRelationshipSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
resourceRelationshipSearch
or r
esourceRelationshipQuery
is not of this servicemandatory
- This method must be implemented. ResourceRelationshipQuery getResourceRelationshipQueryFromInspector(ResourceRelationshipQueryInspector resourceRelationshipQueryInspector)
ResourceRelationshipSearchResults.
resourceRelationshipQueryInspector
- a query inspectorNullArgumentException
-
resourceRelationshipQueryInspector
is null
UnsupportedException
-
resourceRelationshipQueryInspector
is not of this
servicemandatory
- This method must be implemented.