public class SearchConfiguration extends Object
builder(String)
.Modifier and Type | Field and Description |
---|---|
private List<org.apache.commons.lang3.tuple.Pair<String,Integer>> |
baselineCondition
List of pairs of { spaceKey, baselineNumber }
|
private boolean |
fillBaseline |
private boolean |
fillDependencies
True if the dependencies must be filled
|
private boolean |
fillLinks
True if the links (pages, Jira, external) must be filled
|
private boolean |
fillLinksDetails
True if the details of the links (page titles) must be filled
|
private boolean |
fillOrigin
True if the 'origin' (page, external) fields must be filled
|
private boolean |
fillProperties
True if we fill the properties
|
private boolean |
includeArchived |
private boolean |
includeDeleted |
private Integer |
limit |
private Integer |
offset |
private String |
order |
private String |
sort |
private List<String> |
spaceKeys |
private static int |
USE_GLOBAL_LIMIT
A limit that can be used for the `limit` parameter in the search.
|
private static int |
USE_LIMIT_FOR_IMPORT
A limit that can be used for the `limit` parameter in the search.
|
private static int |
USE_LIMIT_FOR_UI
A limit that can be used for the `limit` parameter in the search.
|
Modifier | Constructor and Description |
---|---|
private |
SearchConfiguration(String defaultSpaceKey)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static SearchConfiguration |
builder(String defaultSpaceKey)
Returns a builder.
|
private void |
checkLimitNotNull() |
List<org.apache.commons.lang3.tuple.Pair<String,Integer>> |
getBaselineCondition()
Returns a list of pairs of { spaceKey, baselineNumber }
|
Integer |
getLimit() |
Integer |
getOffset() |
String |
getOrder() |
String |
getSort() |
List<String> |
getSpaceKeys() |
SearchConfiguration |
inBaselines(String baselineConditionString)
A condition for baselines.
|
SearchConfiguration |
includeArchived(boolean includeArchived)
Include archived requirements.
|
SearchConfiguration |
includeDeleted(boolean includeDeleted)
Include deleted requirements.
|
boolean |
isCrossSpace() |
boolean |
isFillAnyDetail() |
boolean |
isFillBaseline() |
boolean |
isFillDependencies() |
boolean |
isFillLinks() |
boolean |
isFillLinksDetails() |
boolean |
isFillOrigin() |
boolean |
isFillProperties() |
boolean |
isIncludeArchived() |
boolean |
isIncludeDeleted() |
boolean |
isUseGlobalLimit() |
boolean |
isUseLimitForImport() |
boolean |
isUseLimitForUI() |
SearchConfiguration |
limit(Integer limit)
The limit.
|
SearchConfiguration |
offset(Integer offset)
The offset.
|
SearchConfiguration |
sort(String sort,
String order)
The ordering.
|
SearchConfiguration |
useGlobalLimit() |
SearchConfiguration |
useLimitForImport() |
SearchConfiguration |
useLimitForUI() |
SearchConfiguration |
withFillBaseline(boolean fillBaseline)
Whether to fill the details of the baseline.
|
SearchConfiguration |
withFillDependencies(boolean fillDependencies)
Whether to list the dependencies.
|
SearchConfiguration |
withFillDetails(boolean fillAll)
Shorthand to set all the fill* values together
|
SearchConfiguration |
withFillLinks(boolean fillLinks)
Whether to fill the list of links.
|
SearchConfiguration |
withFillLinksDetails(boolean fillLinksDetails)
Whether to fetch the details (page title) of the origin and links.
|
SearchConfiguration |
withFillOrigin(boolean fillOrigin)
Whether to fill the list of origin (or duplicate-origin) pages (or external source).
|
SearchConfiguration |
withFillProperties(boolean fillProperties)
Whether to fill the properties.
|
SearchConfiguration |
withSpaceKeys(List<String> spaceKeys)
Add space keys to widen the scope of the search
|
SearchConfiguration |
withSpaceKeys(String spaceKeys)
Add space keys to widen the scope of the search.
|
private static int USE_GLOBAL_LIMIT
private static int USE_LIMIT_FOR_UI
private static int USE_LIMIT_FOR_IMPORT
private boolean includeDeleted
private boolean includeArchived
private List<org.apache.commons.lang3.tuple.Pair<String,Integer>> baselineCondition
private Integer offset
private Integer limit
private String sort
private String order
private boolean fillBaseline
private boolean fillOrigin
private boolean fillLinks
private boolean fillLinksDetails
private boolean fillDependencies
private boolean fillProperties
private SearchConfiguration(String defaultSpaceKey)
defaultSpaceKey
- the default space key, which will be used for the search and it will also be used
when a baseline is referenced by number. Required.
Set to null for a cross-space search.public static SearchConfiguration builder(String defaultSpaceKey)
defaultSpaceKey
- the default space key, which will be used for the search and it will also be used
when a baseline is referenced by number. Required.
Set to null for a cross-space search.public SearchConfiguration withSpaceKeys(String spaceKeys)
spaceKeys
- A comma-separated list of space keys.public SearchConfiguration withSpaceKeys(List<String> spaceKeys)
public SearchConfiguration includeDeleted(boolean includeDeleted)
Default: false.
public SearchConfiguration includeArchived(boolean includeArchived)
Default: false.
@Internal public SearchConfiguration inBaselines(String baselineConditionString)
Default: No baseline criteria.
public SearchConfiguration useGlobalLimit()
public SearchConfiguration useLimitForUI()
public SearchConfiguration useLimitForImport()
public SearchConfiguration offset(Integer offset)
Default: null, which equates to 0.
public SearchConfiguration limit(Integer limit)
It is mandatory to set a limit. Use useLimitForUI() if not sure.
private void checkLimitNotNull()
public SearchConfiguration sort(String sort, String order)
Default is "KEY ASC, BASELINE DESC" which, ironically, you can't enter through this signature.
sort
- the column, precisely the ActiveObjects name of the columnorder
- ASC, DESC or nullpublic SearchConfiguration withFillDetails(boolean fillAll)
public SearchConfiguration withFillBaseline(boolean fillBaseline)
public SearchConfiguration withFillOrigin(boolean fillOrigin)
public SearchConfiguration withFillLinks(boolean fillLinks)
public SearchConfiguration withFillLinksDetails(boolean fillLinksDetails)
public SearchConfiguration withFillDependencies(boolean fillDependencies)
public SearchConfiguration withFillProperties(boolean fillProperties)
public boolean isCrossSpace()
public boolean isIncludeDeleted()
public boolean isIncludeArchived()
public List<org.apache.commons.lang3.tuple.Pair<String,Integer>> getBaselineCondition()
public Integer getOffset()
public Integer getLimit()
public boolean isUseGlobalLimit()
public boolean isUseLimitForImport()
public boolean isUseLimitForUI()
public String getSort()
public String getOrder()
public boolean isFillAnyDetail()
public boolean isFillBaseline()
public boolean isFillOrigin()
public boolean isFillLinks()
public boolean isFillLinksDetails()
public boolean isFillDependencies()
public boolean isFillProperties()
Copyright © 2021 Play SQL. All rights reserved.