Modifier and Type | Field and Description |
---|---|
protected String |
descriptorKey |
protected String |
documentId
The project key or
the name of the ReqIf file.
|
protected String |
documentVersionId
If the requirement is archived, this is the version of the document.
|
protected String |
markerInDocument
The item ID or
the UUID of the ReqIf file.
|
Constructor and Description |
---|
ImportedRef() |
ImportedRef(String descriptorKey,
String documentId,
String documentVersionId,
String markerInDocument) |
Modifier and Type | Method and Description |
---|---|
String |
getDescriptorKey() |
String |
getDocumentId() |
DocumentId |
getDocumentIdBean(String spaceKey) |
String |
getDocumentVersionId() |
String |
getMarkerInDocument() |
void |
set(String title,
String url)
Set the title and url of document.
|
void |
setDescriptorKey(String descriptorKey) |
void |
setDocumentId(String documentId,
String documentVersionId) |
void |
setMarkerInDocument(String markerInDocument) |
String |
toString() |
protected String descriptorKey
protected String documentId
protected String documentVersionId
protected String markerInDocument
public String getDescriptorKey()
public void setDescriptorKey(String descriptorKey)
public DocumentId getDocumentIdBean(String spaceKey)
public String getDocumentId()
public String getDocumentVersionId()
public String getMarkerInDocument()
public void setMarkerInDocument(String markerInDocument)
public void set(String title, String url)
Descriptor.fillDocumentDetails(java.lang.String, com.playsql.requirementyogi.api.beans.Requirement, com.playsql.requirementyogi.api.beans.ImportedRef, java.util.Map<java.lang.String, java.lang.Object>)
, although it is not mandatory.title
- the title of the document (free text, don't forget to specify the version).url
- the URL. If relative, please include Confluence's context path, because we won't add it.
It can be obtained using ContextPathHolder
, or the absolute baseurl can
be obtained using ApplicationProperties
.Copyright © 2021 Play SQL. All rights reserved.