| 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.permissions |
Permission-related classes and interfaces
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
PermissionAPI.hasPermission(RequirementKey requirement,
com.atlassian.confluence.user.ConfluenceUser user,
Perm perm)
Checks whether the user has permissions on this requirement.
|
void |
ExternalPropertiesAPI.setExternalProperty(RequirementKey key,
Property property)
Set an external property for a given requirement.
|
| Modifier and Type | Class and Description |
|---|---|
class |
Requirement |
class |
RequirementKeyBean |
class |
RequirementRef |
| Modifier and Type | Method and Description |
|---|---|
boolean |
RequirementKeyBean.isTarget(RequirementKey requirement) |
void |
Property.setSearchUrl(RequirementKey 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.
|
| Constructor and Description |
|---|
RequirementKeyBean(RequirementKey key) |
| Modifier and Type | Method and Description |
|---|---|
void |
PermissionChecker.checkPermission(RequirementKey requirement) |
PermissionException |
PermissionChecker.getPermissionException(RequirementKey requirement) |
boolean |
PermissionChecker.hasPermission(RequirementKey requirement)
Return true of false depending on whether the user has the permissino on the requirement
|
| Constructor and Description |
|---|
PermissionException(RequirementKey requirementKey,
String userFullName,
Perm perm) |
Copyright © 2022 Requirement Yogi. All rights reserved.