Package | Description |
---|---|
com.playsql.requirementyogi.api |
This is where you start when trying to use Requirement Yogi's Java APIs.
|
com.playsql.requirementyogi.api.search |
Search-related classes and interfaces
|
Modifier and Type | Method and Description |
---|---|
SearchResult<Requirement> |
SearchAPI.search(com.playsql.requirementyogi.search.utils.RYSearchQuery searchQuery,
SearchConfiguration searchConfiguration)
Search for requirements.
|
SearchResult<Requirement> |
SearchAPI.search(String searchQuery,
SearchConfiguration searchConfiguration)
Deprecated.
2.6.3 Variables are now supported, you can use
SearchAPI.search(String, SearchConfiguration, Map) |
SearchResult<Requirement> |
SearchAPI.search(String searchQuery,
SearchConfiguration searchConfiguration,
com.atlassian.confluence.user.ConfluenceUser user)
Search for requirements.
|
SearchResult<Requirement> |
SearchAPI.search(String searchQuery,
SearchConfiguration searchConfiguration,
Map<com.playsql.requirementyogi.reporting.api.enums.SupportedVariable,Object> variableMap)
Search for requirements.
|
SearchResult<Requirement> |
SearchAPI.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> |
SearchAPI.search(String searchQuery,
SearchConfiguration searchConfiguration,
com.playsql.requirementyogi.utils.Stashes stashes)
Deprecated.
2.6.3 Variables are now supported, you can use
SearchAPI.search(String, SearchConfiguration, Map) |
Modifier and Type | Method and Description |
---|---|
static SearchConfiguration |
SearchConfiguration.builder(String defaultSpaceKey)
Returns a builder.
|
SearchConfiguration |
SearchConfiguration.inBaselines(String baselineConditionString)
A condition for baselines.
|
SearchConfiguration |
SearchConfiguration.includeArchived(boolean includeArchived)
Include archived requirements.
|
SearchConfiguration |
SearchConfiguration.limit(Integer limit)
The limit.
|
SearchConfiguration |
SearchConfiguration.offset(Integer offset)
The offset.
|
SearchConfiguration |
SearchConfiguration.sort(String sort,
String order)
The ordering.
|
SearchConfiguration |
SearchConfiguration.useGlobalLimit() |
SearchConfiguration |
SearchConfiguration.useLimitForImport() |
SearchConfiguration |
SearchConfiguration.useLimitForUI() |
SearchConfiguration |
SearchConfiguration.useTimeout(TimeoutUtils.Timeout timeout)
If present, we halt processing after this timeout
|
SearchConfiguration |
SearchConfiguration.with(FetchDetails.BASELINE fillBaseline)
Whether to fill the details of the baseline.
|
SearchConfiguration |
SearchConfiguration.with(FetchDetails.DELETED deleted)
Include/Exclude deleted requirements.
|
SearchConfiguration |
SearchConfiguration.with(FetchDetails.DEPENDENCIES fillDependencies)
Whether to list the dependencies.
|
SearchConfiguration |
SearchConfiguration.with(FetchDetails.LINKS_DETAILS fillLinksDetails)
Whether to fetch the details (page title) of the origin and links.
|
SearchConfiguration |
SearchConfiguration.with(FetchDetails.LINKS fillLinks)
Whether to fill the list of links.
|
SearchConfiguration |
SearchConfiguration.with(FetchDetails.ORIGIN fillOrigin)
Whether to fill the list of origin (or duplicate-origin) pages (or external source).
|
SearchConfiguration |
SearchConfiguration.with(FetchDetails.PROPERTIES fillProperties)
Whether to fill the properties.
|
SearchConfiguration |
SearchConfiguration.with(FetchDetails.PROPERTY_NAME_META fillPropertyNameMeta)
Wether to fill the property name meta
Default is EXCLUDE
|
SearchConfiguration |
SearchConfiguration.withFillDetails(boolean fillAll)
Shorthand to set all the fill* values together
(except propertyNameMeta)
|
SearchConfiguration |
SearchConfiguration.withFillOrigin(boolean fillOrigin)
Only used by ComalaResource (external plugin)
|
SearchConfiguration |
SearchConfiguration.withSpaceKeys(List<String> spaceKeys)
Add space keys to widen the scope of the search
|
SearchConfiguration |
SearchConfiguration.withSpaceKeys(String spaceKeys)
Add space keys to widen the scope of the search.
|
Copyright © 2022 Requirement Yogi. All rights reserved.