public interface RepositorySearchSession extends RepositoryQuerySession
This session provides methods for searching among Repository
objects. The search query is constructed using the
RepositoryQuery.
getRepositoriesByQuery()
is the basic search method and
returns a list of Repository
objects.A more advanced search
may be performed with getRepositoriesBySearch().
It accepts
a RepositorySearch
in addition to the query for the purpose
of specifying additional options affecting the entire search, such as
ordering. getRepositoriesBySearch()
returns a
RepositorySearchResults
that can be used to access the resulting
RepositoryList
or be used to perform a search within the
result set through RepositorySearch.
Repositories may have a query record indicated by their respective
record types. The query record is accessed via the RepositoryQuery.
Modifier and Type | Method and Description |
---|---|
RepositorySearchResults |
getRepositoriesBySearch(RepositoryQuery repositoryQuery,
RepositorySearch repositorySearch)
Gets the search results matching the given search query using the
given search.
|
RepositoryQuery |
getRepositoryQueryFromInspector(RepositoryQueryInspector repositoryQueryInspector)
Gets a repository query from an inspector.
|
RepositorySearch |
getRepositorySearch()
Gets a repository search.
|
RepositorySearchOrder |
getRepositorySearchOrder()
Gets a repository search order.
|
canSearchRepositories, getRepositoriesByQuery, getRepositoryQuery
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
RepositorySearch getRepositorySearch()
mandatory
- This method must be implemented. RepositorySearchOrder getRepositorySearchOrder()
RepositorySearchOrder
is supplied to a RepositorySearch
to specify
the ordering of results.mandatory
- This method must be implemented. RepositorySearchResults getRepositoriesBySearch(RepositoryQuery repositoryQuery, RepositorySearch repositorySearch) throws OperationFailedException, PermissionDeniedException
repositoryQuery
- the repository queryrepositorySearch
- the repository searchNullArgumentException
- repositoryQuery
or repositorySearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- repositoryQuery
or repositorySearch
is not of this servicemandatory
- This method must be implemented. RepositoryQuery getRepositoryQueryFromInspector(RepositoryQueryInspector repositoryQueryInspector)
RepositorySearchResults.
repositoryQueryInspector
- a repository query inspectorNullArgumentException
- repositoryQueryInspector
is null
UnsupportedException
- repositoryQueryInspector
is not of this servicemandatory
- This method must be implemented.