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 |
fillDetails |
private boolean |
includeArchived |
private boolean |
includeDeleted |
private Integer |
limit |
private Integer |
offset |
private String |
order |
private String |
sort |
private List<String> |
spaceKeys |
(package private) static int |
USE_GLOBAL_LIMIT
A limit that can be used for the `limit` parameter in the search.
|
(package private) static int |
USE_LIMIT_FOR_IMPORT
A limit that can be used for the `limit` parameter in the search.
|
(package 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 |
isFillDetails() |
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 |
withFillDetails(boolean fillDetails)
Whether to fill the details of the requirements.
|
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.
|
static int USE_GLOBAL_LIMIT
static int USE_LIMIT_FOR_UI
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 fillDetails
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 "REQKEY 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 fillDetails)
Default is true.
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 isFillDetails()
Copyright © 2020 Play SQL. All rights reserved.