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.
|
com.playsql.requirementyogi.api.permissions |
Permission-related classes and interfaces
|
Modifier and Type | Method and Description |
---|---|
Requirement |
RequirementService.getRequirement(String spaceKey,
String key,
Integer baseline)
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(String searchQuery,
SearchConfiguration searchConfiguration)
Search for requirements.
|
SearchResult<Requirement> |
SearchAPI.search(String searchQuery,
SearchConfiguration searchConfiguration,
com.atlassian.confluence.user.ConfluenceUser user)
Search for requirements.
|
SearchResult<Requirement> |
RequirementService.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) |
Modifier and Type | Method and Description |
---|---|
boolean |
PermissionAPI.hasPermission(Requirement requirement,
com.atlassian.confluence.user.ConfluenceUser user,
Perm perm)
Checks whether the user has permissions on this requirement.
|
void |
DocumentImporterAPI.RequirementPersister.saveRequirement(Requirement requirement)
Saves 1 requirement.
|
Modifier and Type | Method and Description |
---|---|
static Requirement |
Requirement.of(com.playsql.requirementyogi.ao.v33.AORequirement from) |
Modifier and Type | Method and Description |
---|---|
static List<Requirement> |
Requirement.of(com.playsql.requirementyogi.ao.v33.AORequirement[] from) |
static List<Requirement> |
Requirement.of(Iterable<com.playsql.requirementyogi.ao.v33.AORequirement> from) |
Modifier and Type | Method and Description |
---|---|
boolean |
RequirementRef.isTarget(Requirement requirement) |
void |
Property.setSearchUrl(Requirement requirement)
A "simple property" has a key:
- single word
- Only letters and numbers
- <80 characters
- A value between 1 and 100 characters
and a non-blank value.
|
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) . |
Modifier and Type | Method and Description |
---|---|
void |
PermissionChecker.checkPermission(Requirement requirement) |
boolean |
PermissionChecker.hasPermission(Requirement requirement)
Return true of false depending on whether the user has the permissino on the requirement
|
Copyright © 2020 Play SQL. All rights reserved.