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 FetchDetails.DELETED |
deleted |
private FetchDetails.BASELINE |
fetchBaseline |
private FetchDetails.DEPENDENCIES |
fetchDependencies
INCLUDE if the dependencies must be filled
|
private FetchDetails.LINKS |
fetchLinks
INCLUDE if the links (pages, Jira, external) must be filled
|
private FetchDetails.LINKS_DETAILS |
fetchLinksDetails
INCLUDE if the details of the links (page titles) must be filled
|
private FetchDetails.ORIGIN |
fetchOrigin
INCLUDE if the 'origin' (page, external) fields must be filled
|
private FetchDetails.PROPERTIES |
fetchProperties
INCLUDE if we fill the properties
|
private FetchDetails.PROPERTY_NAME_META |
fillPropertyNameMeta
INCLUDE if we fill the property name meta
|
private boolean |
includeArchived |
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() |
FetchDetails.DEPENDENCIES |
fetchDependencies() |
FetchDetails.LINKS |
fetchLinks() |
FetchDetails.LINKS_DETAILS |
fetchLinksDetails() |
FetchDetails.ORIGIN |
fetchOrigin() |
FetchDetails.PROPERTIES |
fetchProperties() |
FetchDetails.PROPERTY_NAME_META |
fetchPropertyNameMeta() |
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.
|
boolean |
includeBaseline() |
boolean |
isCrossSpace() |
boolean |
isFillAnyDetail() |
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 |
with(FetchDetails.BASELINE fillBaseline)
Whether to fill the details of the baseline.
|
SearchConfiguration |
with(FetchDetails.DELETED deleted)
Include/Exclude deleted requirements.
|
SearchConfiguration |
with(FetchDetails.DEPENDENCIES fillDependencies)
Whether to list the dependencies.
|
SearchConfiguration |
with(FetchDetails.LINKS_DETAILS fillLinksDetails)
Whether to fetch the details (page title) of the origin and links.
|
SearchConfiguration |
with(FetchDetails.LINKS fillLinks)
Whether to fill the list of links.
|
SearchConfiguration |
with(FetchDetails.ORIGIN fillOrigin)
Whether to fill the list of origin (or duplicate-origin) pages (or external source).
|
SearchConfiguration |
with(FetchDetails.PROPERTIES fillProperties)
Whether to fill the properties.
|
SearchConfiguration |
with(FetchDetails.PROPERTY_NAME_META fillPropertyNameMeta)
Wether to fill the property name meta
Default is EXCLUDE
|
SearchConfiguration |
withFillDetails(boolean fillAll)
Shorthand to set all the fill* values together
(except propertyNameMeta)
|
SearchConfiguration |
withFillOrigin(boolean fillOrigin)
Only used by ComalaResource (external plugin)
|
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 final int USE_GLOBAL_LIMIT
private static final int USE_LIMIT_FOR_UI
private static final int USE_LIMIT_FOR_IMPORT
private FetchDetails.DELETED deleted
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 FetchDetails.BASELINE fetchBaseline
private FetchDetails.ORIGIN fetchOrigin
private FetchDetails.LINKS fetchLinks
private FetchDetails.LINKS_DETAILS fetchLinksDetails
private FetchDetails.DEPENDENCIES fetchDependencies
private FetchDetails.PROPERTIES fetchProperties
private FetchDetails.PROPERTY_NAME_META fillPropertyNameMeta
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 with(FetchDetails.DELETED deleted)
Default: EXCLUDE.
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 with(FetchDetails.BASELINE fillBaseline)
public SearchConfiguration with(FetchDetails.ORIGIN fillOrigin)
public SearchConfiguration withFillOrigin(boolean fillOrigin)
public SearchConfiguration with(FetchDetails.LINKS fillLinks)
public SearchConfiguration with(FetchDetails.LINKS_DETAILS fillLinksDetails)
public SearchConfiguration with(FetchDetails.DEPENDENCIES fillDependencies)
public SearchConfiguration with(FetchDetails.PROPERTIES fillProperties)
public SearchConfiguration with(FetchDetails.PROPERTY_NAME_META fillPropertyNameMeta)
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 includeBaseline()
public FetchDetails.ORIGIN fetchOrigin()
public FetchDetails.LINKS fetchLinks()
public FetchDetails.LINKS_DETAILS fetchLinksDetails()
public FetchDetails.DEPENDENCIES fetchDependencies()
public FetchDetails.PROPERTIES fetchProperties()
public FetchDetails.PROPERTY_NAME_META fetchPropertyNameMeta()
Copyright © 2022 Requirement Yogi. All rights reserved.