public class Requirement extends Object implements com.playsql.utils.api.interfaces.RequirementKey
Modifier and Type | Field and Description |
---|---|
private Integer |
baseline
The baseline of the requirement.
|
private Baseline |
baselineDetails |
private List<RequirementRef> |
dependencies
Deprecated.
It is not recommended to use those anymore, as there can be a lot of dependencies.
Please use DependencyDAO now, to only fetch dependencies when needed.
|
private String |
destinationUrl |
private List<Ref> |
duplicateOriginalPages |
private String |
formattingCss
A CSS attribute, converted from the Property "_formatting" using Property.convertToCss().
|
private Boolean |
formattingNoBorder
True if the "aui-label" border should be removed.
|
private String |
genericUrl |
private String |
htmlExcerpt |
private boolean |
htmlNeedsUpdating |
private Long |
id
Deprecated.
To be removed in RY 4.0 (or more precisely, annotated so that its value is not visible in the UI).
|
private Boolean |
isPublicDescription
True if the space administrator has decided that the requirement descriptions can be managed in Jira and
are, therefore, public in the sense that everyone can see them.
|
private List<JiraRef> |
issues
Deprecated.
in version 3.0, please use DependencyDAO instead.
Since we can have a lot of links, using this property is not recommended.
Also, it is null by default and only filled on demand.
|
private String |
key |
private String |
newSpaceKey |
private Ref |
origin
The place where the requirement is defined.
|
private List<Property> |
properties |
private List<PageRef> |
references
Deprecated.
Since we can have a lot of links, using this property is not recommended.
Also, it is null by default and only filled on demand
|
private List<RequirementRef> |
reverseDependencies |
private String |
searchForVersionsUrl
URL to search for different baselines of the requirement
|
private String |
spaceKey |
private String |
status |
private Map<String,List<TestRef>> |
tests
Deprecated.
in version 3.0, please use DependencyDAO to retrieve the details of the tests.
|
Constructor and Description |
---|
Requirement() |
Requirement(com.playsql.requirementyogi.ao.v60.DBRequirement from) |
Requirement(String spaceKey,
String key,
Integer baseline)
Constructor for the primary key
|
Modifier and Type | Method and Description |
---|---|
void |
addOrigin(Ref origin) |
boolean |
equals(Object o) |
private <T> List<T> |
filter1(List<T> list,
Predicate<T> predicate) |
Integer |
getBaseline()
The baseline.
|
Baseline |
getBaselineDetails() |
List<PageRef> |
getDeduplicatedReferences()
Returns a filtered list of PageRef, with only 1 link per page
|
List<RequirementRef> |
getDependencies(com.playsql.requirementyogi.ao.v60.DBDependency.Side side,
String relationship)
Deprecated.
Please use DependencyDAO when possible.
|
List<RequirementRef> |
getDependenciesForSave()
The only legitimate use-case of retrieving dependencies is when we save them.
|
String |
getDestinationUrl() |
List<Ref> |
getDuplicateOriginalPages() |
String |
getFormattingCss() |
Boolean |
getFormattingNoBorder() |
String |
getGenericUrl() |
String |
getHtmlExcerpt() |
Long |
getId() |
List<JiraRef> |
getIssues() |
Iterable<JiraRef> |
getIssues(String relationship) |
String |
getKey()
The requirement key.
|
String |
getNewSpaceKey() |
Ref |
getOrigin() |
Long |
getPageId()
Retrieve the pageID, based on the 'origin' or 'page' member.
|
List<Property> |
getProperties() |
Property |
getProperty(String key,
PropertyType type)
Returns the property matching the key and type
|
Boolean |
getPublicDescription() |
List<PageRef> |
getReferences() |
List<PageRef> |
getReferencesExcludingDependencies()
Deprecated.
This list is not guaranteed to be complete, and we now use the parent/child vocabulary.
Use DependencyDAO when possible.
|
List<RequirementRef> |
getReverseDependencies()
Deprecated.
|
List<RequirementRef> |
getReverseDependencies(String relationship)
Deprecated.
|
String |
getSearchForVersionsUrl() |
String |
getSpaceKey()
Return the space key of the requirement.
|
String |
getStatus() |
Map<String,List<TestRef>> |
getTests() |
List<TestRef> |
getTests(String relationship) |
List<TestRef> |
getTestsAsList() |
int |
hashCode() |
boolean |
isHtmlNeedsUpdating() |
static List<Requirement> |
of(com.playsql.requirementyogi.ao.v60.DBRequirement... from) |
static Requirement |
of(com.playsql.requirementyogi.ao.v60.DBRequirement from) |
void |
resetOrigin()
Resets the "origin" field so we can use
addOrigin(com.playsql.requirementyogi.api.beans.Ref) and count the duplicates from 0 |
void |
setBaseline(Integer baseline) |
void |
setBaselineDetails(Baseline baselineDetails) |
void |
setDependencies(List<RequirementRef> dependencies)
Set the PARENT dependencies.
|
void |
setDestinationUrl(String destinationUrl) |
void |
setFormattingCss(String formattingCss) |
void |
setFormattingNoBorder(Boolean formattingNoBorder) |
void |
setGenericUrl(String genericUrl) |
void |
setHtmlExcerpt(String htmlExcerpt) |
void |
setId(long id) |
void |
setIssues(List<JiraRef> issues) |
void |
setKey(String key) |
void |
setNewSpaceKey(String newSpaceKey) |
void |
setOrigin(Ref origin) |
void |
setProperties(List<Property> properties) |
void |
setPublicDescription(Boolean publicDescription) |
void |
setReferences(List<PageRef> references) |
void |
setReverseDependencies(List<RequirementRef> reverseDependencies)
Deprecated.
in RY 3.0. We want to move away from built-in unbounded lists.
Use DependencyDAO when possible.
|
void |
setSearchForVersionsUrl(String searchForVersionsUrl) |
void |
setSpaceKey(String spaceKey) |
void |
setStatus(String status) |
void |
setTests(Map<String,List<TestRef>> tests) |
void |
sort()
Sort the links again after adding page titles and so on
|
String |
toString() |
@Deprecated private Long id
private String key
private String spaceKey
private Integer baseline
private Baseline baselineDetails
private String newSpaceKey
private String status
private String htmlExcerpt
private boolean htmlNeedsUpdating
private Ref origin
private List<PageRef> references
private Map<String,List<TestRef>> tests
private List<JiraRef> issues
private List<RequirementRef> dependencies
private List<RequirementRef> reverseDependencies
private String genericUrl
private String destinationUrl
private String searchForVersionsUrl
private String formattingCss
private Boolean formattingNoBorder
private Boolean isPublicDescription
public Requirement()
public Requirement(String spaceKey, String key, Integer baseline)
public Requirement(com.playsql.requirementyogi.ao.v60.DBRequirement from)
public void sort()
public static Requirement of(com.playsql.requirementyogi.ao.v60.DBRequirement from)
public static List<Requirement> of(com.playsql.requirementyogi.ao.v60.DBRequirement... from)
public Long getId()
public void setId(long id)
public String getKey()
com.playsql.utils.api.interfaces.RequirementKey
getKey
in interface com.playsql.utils.api.interfaces.RequirementKey
public void setKey(String key)
public String getHtmlExcerpt()
public void setHtmlExcerpt(String htmlExcerpt)
public Long getPageId()
public Ref getOrigin()
public void setOrigin(Ref origin)
public void resetOrigin()
addOrigin(com.playsql.requirementyogi.api.beans.Ref)
and count the duplicates from 0public void addOrigin(Ref origin)
public List<PageRef> getDeduplicatedReferences()
public List<PageRef> getReferencesExcludingDependencies()
public String getGenericUrl()
public void setGenericUrl(String genericUrl)
public String getDestinationUrl()
public void setDestinationUrl(String destinationUrl)
public String getSpaceKey()
com.playsql.utils.api.interfaces.Spaced
getSpaceKey
in interface com.playsql.utils.api.interfaces.Spaced
public void setSpaceKey(String spaceKey)
public String getStatus()
public void setStatus(String status)
public String getNewSpaceKey()
public void setNewSpaceKey(String newSpaceKey)
@Nullable public Property getProperty(String key, PropertyType type)
public void setDependencies(List<RequirementRef> dependencies)
public List<RequirementRef> getDependenciesForSave()
public List<RequirementRef> getDependencies(com.playsql.requirementyogi.ao.v60.DBDependency.Side side, String relationship)
public List<RequirementRef> getReverseDependencies()
getDependencies(DBDependency.Side, String)
public List<RequirementRef> getReverseDependencies(String relationship)
getDependencies(DBDependency.Side, String)
public void setReverseDependencies(List<RequirementRef> reverseDependencies)
public void setBaseline(Integer baseline)
public Integer getBaseline()
com.playsql.utils.api.interfaces.RequirementKey
getBaseline
in interface com.playsql.utils.api.interfaces.RequirementKey
public Baseline getBaselineDetails()
public void setBaselineDetails(Baseline baselineDetails)
public boolean isHtmlNeedsUpdating()
public String getFormattingCss()
public Boolean getFormattingNoBorder()
public void setFormattingCss(String formattingCss)
public void setFormattingNoBorder(Boolean formattingNoBorder)
public Boolean getPublicDescription()
public void setPublicDescription(Boolean publicDescription)
public String getSearchForVersionsUrl()
public void setSearchForVersionsUrl(String searchForVersionsUrl)
Copyright © 2022 Requirement Yogi. All rights reserved.