| 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 |
|---|---|
ImportResults |
DocumentImporterAPI.importDocument(DocumentId documentId,
String title,
com.atlassian.confluence.user.ConfluenceUser user,
Consumer<DocumentImporterAPI.RequirementPersister> callback)
Import a document.
|
| Modifier and Type | Method and Description |
|---|---|
DocumentId |
ImportedRef.getDocumentIdBean(String spaceKey) |
| Modifier and Type | Field and Description |
|---|---|
private DocumentId |
Document.documentId
The primary key of the document
|
| Modifier and Type | Method and Description |
|---|---|
DocumentId |
VersioningDescriptor.createHistoricalVersionOfDocument(DocumentId currentDocumentId)
Create an archived revision of this document, so the requirements in a baseline relating to this requirement
have an ORIGIN link to point to.
|
DocumentId |
Document.getId() |
| Modifier and Type | Method and Description |
|---|---|
DocumentId |
VersioningDescriptor.createHistoricalVersionOfDocument(DocumentId currentDocumentId)
Create an archived revision of this document, so the requirements in a baseline relating to this requirement
have an ORIGIN link to point to.
|
Document |
Descriptor.getDocumentMetadata(DocumentId documentId)
Get the document metadata for an active version of the document.
|
Document |
VersioningDescriptor.getVersionedDocumentMetadata(DocumentId documentId)
Same as
Descriptor.getDocumentMetadata(DocumentId)
Get the document metadata. |
| Constructor and Description |
|---|
Document(DocumentId documentId,
String title,
String url) |
DocumentId(DocumentId latestVersionId,
String versionId)
Constructor for an older version of a document
|
Copyright © 2022 Requirement Yogi. All rights reserved.