Method Detail

• createHistoricalVersionOfDocument

  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. For example, if we managed requirements in Confluence pages, this would create an archived version of the page and return its version number. The version number can be any arbitrary text or string.

  Parameters:

  currentDocumentId - the original document, from which to create an archived version

  Returns:

  the new documentVersionId of this version, so that next time 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>) is called with a documentVersionId, the descriptor should be able to set the URL and title for this specific version.

• getVersionedDocumentMetadata

  Document getVersionedDocumentMetadata(@Nonnull
                                        DocumentId documentId)

  Same as 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-3000

  Parameters:

  documentId - 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.

  Returns:

  the title, url and type of the document