Package | Description |
---|---|
com.playsql.requirementyogi.api |
This is where you start when trying to use Requirement Yogi's Java APIs.
|
com.playsql.requirementyogi.api.beans |
Core JavaBean objects representing Requirement Yogi's data: Requirements, references, baselines etc.
|
com.playsql.requirementyogi.api.documentimporter |
Classes and interfaces related to extending Requirement Yogi with a document importer.
|
Modifier and Type | Method and Description |
---|---|
Requirement |
RequirementService.getRequirement(String spaceKey,
String key,
Integer baseline)
Deprecated.
since 3.0, please use
RequirementService.getRequirement(String, String, Integer, Stashes) |
Requirement |
RequirementService.getRequirement(String spaceKey,
String key,
Integer baseline,
com.playsql.requirementyogi.utils.Stashes stashes)
Retrieve an arbitrary requirement.
|
Modifier and Type | Method and Description |
---|---|
List<Requirement> |
RequirementService.getAllVersionsOfRequirement(String spaceKey,
String key)
Fetch all versions of a requirement and fill its full details.
|
SearchResult<Requirement> |
SearchAPI.search(com.playsql.requirementyogi.search.utils.RYSearchQuery searchQuery,
SearchConfiguration searchConfiguration)
Search for requirements.
|
SearchResult<Requirement> |
SearchAPI.search(String searchQuery,
SearchConfiguration searchConfiguration)
Deprecated.
2.6.3 Variables are now supported, you can use
SearchAPI.search(String, SearchConfiguration, Map) |
SearchResult<Requirement> |
SearchAPI.search(String searchQuery,
SearchConfiguration searchConfiguration,
com.atlassian.confluence.user.ConfluenceUser user)
Search for requirements.
|
SearchResult<Requirement> |
SearchAPI.search(String searchQuery,
SearchConfiguration searchConfiguration,
Map<com.playsql.requirementyogi.reporting.api.enums.SupportedVariable,Object> variableMap)
Search for requirements.
|
SearchResult<Requirement> |
SearchAPI.search(String searchQuery,
SearchConfiguration searchConfiguration,
Map<com.playsql.requirementyogi.reporting.api.enums.SupportedVariable,Object> variableMap,
com.playsql.requirementyogi.utils.Stashes stashes)
Search for requirements.
|
SearchResult<Requirement> |
SearchAPI.search(String searchQuery,
SearchConfiguration searchConfiguration,
com.playsql.requirementyogi.utils.Stashes stashes)
Deprecated.
2.6.3 Variables are now supported, you can use
SearchAPI.search(String, SearchConfiguration, Map) |
Modifier and Type | Method and Description |
---|---|
void |
DocumentImporterAPI.RequirementPersister.saveRequirement(Requirement requirement)
Saves 1 requirement.
|
Modifier and Type | Method and Description |
---|---|
static Requirement |
Requirement.of(com.playsql.requirementyogi.ao.v60.DBRequirement from) |
Modifier and Type | Method and Description |
---|---|
static List<Requirement> |
Requirement.of(com.playsql.requirementyogi.ao.v60.DBRequirement... from) |
Modifier and Type | Method and Description |
---|---|
void |
Descriptor.fillDocumentDetails(String spaceKey,
Requirement bean,
ImportedRef importedRef,
Map<String,Object> stash)
Using the descriptorKey, documentId, documentVersionId and markerInDocument property, this
method fills the URL and title of the document by calling
ImportedRef.set(String, String) . |
Copyright © 2021 Play SQL. All rights reserved.