public interface RequirementService
Modifier and Type | Field and Description |
---|---|
static int |
USE_GLOBAL_LIMIT
Deprecated.
Since 2.4.3, use
SearchConfiguration.useGlobalLimit() |
static int |
USE_LIMIT_FOR_IMPORT
Deprecated.
Since 2.4.3, use
SearchConfiguration.useLimitForImport() . |
static int |
USE_LIMIT_FOR_UI
Deprecated.
Since 2.4.3, use
SearchConfiguration.useLimitForUI() |
Modifier and Type | Method and Description |
---|---|
List<Requirement> |
getAllVersionsOfRequirement(String spaceKey,
String key)
Fetch all versions of a requirement and fill its full details.
|
Requirement |
getRequirement(String spaceKey,
String key,
Integer baseline)
Retrieve an arbitrary requirement.
|
SearchResult<Requirement> |
search(String searchQuery,
String spaceKeys,
boolean includeDeleted,
boolean includeArchived,
String baselineCondition,
Integer offset,
Integer limit,
String sort,
String order,
boolean fillDetails)
Deprecated.
Since 2.4.3, use
SearchAPI.search(String, SearchConfiguration) |
static final int USE_GLOBAL_LIMIT
SearchConfiguration.useGlobalLimit()
static final int USE_LIMIT_FOR_UI
SearchConfiguration.useLimitForUI()
static final int USE_LIMIT_FOR_IMPORT
SearchConfiguration.useLimitForImport()
.SearchResult<Requirement> search(String searchQuery, String spaceKeys, boolean includeDeleted, boolean includeArchived, String baselineCondition, Integer offset, Integer limit, String sort, String order, boolean fillDetails)
SearchAPI.search(String, SearchConfiguration)
includeDeleted
- almost-always false, since we don't want to let the user see deleted requirements (it
disturbs them).Requirement getRequirement(String spaceKey, String key, Integer baseline) throws PermissionException
SearchAPI
directly.spaceKey
- the space keykey
- the key of the requirementbaseline
- the baseline number in this space, or null for the most recent version of the requirementPermissionException
- an exception if the current user doesn't have the permissions on the requirement.List<Requirement> getAllVersionsOfRequirement(String spaceKey, String key) throws PermissionException
spaceKey
- the space keykey
- the requirement keyPermissionException
- an exception if the user has no permission on these requirementsCopyright © 2020 Play SQL. All rights reserved.