public interface SearchAPI
Modifier and Type | Method and Description |
---|---|
boolean |
hasRequirementsInSpace(String spaceKey)
Return true if there is at least one, even deleted, requirement in this space
|
SearchResult<Requirement> |
search(com.playsql.requirementyogi.search.utils.RYSearchQuery searchQuery,
SearchConfiguration searchConfiguration)
Search for requirements.
|
SearchResult<Requirement> |
search(String searchQuery,
SearchConfiguration searchConfiguration)
Deprecated.
2.6.3 Variables are now supported, you can use
search(String, SearchConfiguration, Map) |
SearchResult<Requirement> |
search(String searchQuery,
SearchConfiguration searchConfiguration,
com.atlassian.confluence.user.ConfluenceUser user)
Search for requirements.
|
SearchResult<Requirement> |
search(String searchQuery,
SearchConfiguration searchConfiguration,
Map<com.playsql.requirementyogi.reporting.api.enums.SupportedVariable,Object> variableMap)
Search for requirements.
|
SearchResult<Requirement> |
search(String searchQuery,
SearchConfiguration searchConfiguration,
Map<com.playsql.requirementyogi.reporting.api.enums.SupportedVariable,Object> variableMap,
com.playsql.requirementyogi.utils.Stashes stashes)
Search for requirements.
|
SearchResult<Requirement> |
search(String searchQuery,
SearchConfiguration searchConfiguration,
com.playsql.requirementyogi.utils.Stashes stashes)
Deprecated.
2.6.3 Variables are now supported, you can use
search(String, SearchConfiguration, Map) |
SearchResult<Requirement> search(String searchQuery, SearchConfiguration searchConfiguration, Map<com.playsql.requirementyogi.reporting.api.enums.SupportedVariable,Object> variableMap)
Permissions are the one of the currently connected user.
searchQuery
- the search query.searchConfiguration
- the configuration for the search.variableMap
- the map containing replacement variables for the query (See SupportedVariable
)SearchResult
of Requirement
SearchResult<Requirement> search(String searchQuery, SearchConfiguration searchConfiguration, Map<com.playsql.requirementyogi.reporting.api.enums.SupportedVariable,Object> variableMap, @Nonnull com.playsql.requirementyogi.utils.Stashes stashes)
Permissions are the one of the currently connected user.
searchQuery
- the search query.searchConfiguration
- the configuration for the search.variableMap
- the map containing replacement variables for the query (See SupportedVariable
)stashes
- the cachesSearchResult
of Requirement
SearchResult<Requirement> search(String searchQuery, SearchConfiguration searchConfiguration)
search(String, SearchConfiguration, Map)
Permissions are the one of the currently connected user.
searchQuery
- the search query.searchConfiguration
- the configuration for the search.SearchResult
of Requirement
SearchResult<Requirement> search(String searchQuery, SearchConfiguration searchConfiguration, @Nonnull com.playsql.requirementyogi.utils.Stashes stashes)
search(String, SearchConfiguration, Map)
Permissions are the one of the currently connected user.
searchQuery
- the search query.searchConfiguration
- the configuration for the search.stashes
- the cachesSearchResult
of Requirement
SearchResult<Requirement> search(String searchQuery, SearchConfiguration searchConfiguration, com.atlassian.confluence.user.ConfluenceUser user)
searchQuery
- the search query.searchConfiguration
- the configuration for the search.user
- the authenticated user (Default is AuthenticatedUserThreadLocal.get())SearchResult
of Requirement
SearchResult<Requirement> search(com.playsql.requirementyogi.search.utils.RYSearchQuery searchQuery, SearchConfiguration searchConfiguration)
Permissions are the one of the currently connected user.
searchQuery
- the search query.searchConfiguration
- the configuration for the search.SearchResult
of Requirement
boolean hasRequirementsInSpace(String spaceKey)
Copyright © 2021 Play SQL. All rights reserved.