public interface VersioningDescriptor extends Descriptor
Modifier and Type | Method and Description |
---|---|
DocumentId |
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 |
getVersionedDocumentMetadata(DocumentId documentId)
Same as
Descriptor.getDocumentMetadata(DocumentId)
Get the document metadata. |
fillDocumentDetails, getAdminURL, getDisplayName, getDocumentationURL, getDocumentMetadata, getKey, getVersion
DocumentId createHistoricalVersionOfDocument(DocumentId currentDocumentId)
currentDocumentId
- the original document, from which to create an archived versionDescriptor.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>)
is called with a
documentVersionId
, the descriptor should be able to set the URL and title for this specific
version.Document getVersionedDocumentMetadata(@Nonnull DocumentId documentId)
Descriptor.getDocumentMetadata(DocumentId)
Get the document metadata. It is used when displaying the absent-document-viewer.action,
at URL /requirementyogi/absent-document-viewer.action?key=AAAAAA&documentId=000000&documentVersionId=2020-3000documentId
- the ID of the document. It must be an 'archived' version of the document, not the active
one, therefore DocumentId.isLatestVersion() must always return false.Copyright © 2022 Requirement Yogi. All rights reserved.