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(String searchQuery,
SearchConfiguration searchConfiguration)
Search for requirements
|
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.includeDeleted(boolean includeDeleted)
Include deleted 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.withFillDetails(boolean fillDetails)
Whether to fill the details of the requirements.
|
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 © 2020 Play SQL. All rights reserved.