public interface Descriptor
<requirementyogi-extension key="any-key" class="com.example.yourplugin.Descriptor" />
Modifier and Type | Method and Description |
---|---|
void |
fillDocumentDetails(String spaceKey,
Requirement bean,
ImportedRef importedRef,
Map<String,Object> stash)
Using the descriptorKey, documentId, documentVersionId and markerInDocument property, this
method fills the URL and title of the document by calling
ImportedRef.set(String, String) . |
String |
getAdminURL()
A URL for the administration, inside of the Confluence instance.
|
String |
getDisplayName()
A human-readable name to display in the UI.
|
String |
getDocumentationURL()
A URL for the documentation, which may be displayed in the administration of RY.
|
Document |
getDocumentMetadata(DocumentId documentId)
Get the document metadata for an active version of the document.
|
String |
getKey()
The key of this descriptor.
|
int |
getVersion()
Returns the version number of the descriptors.
|
String getKey()
String getDisplayName()
String getDocumentationURL()
String getAdminURL()
int getVersion()
Document getDocumentMetadata(@Nonnull DocumentId documentId)
documentId
- the ID of the document. It must be an active version of the document, i.e.
DocumentId.isLatestVersion()
must always return true.void fillDocumentDetails(String spaceKey, @Nullable Requirement bean, ImportedRef importedRef, Map<String,Object> stash)
ImportedRef.set(String, String)
.
Do not modify the Requirement.
If this descriptor supports VersioningDescriptor
, then this method should support
an ImportedRef with a documentVersionId. It this descriptor doesn't support versioning, the
this method would probably not be called.bean
- the parent requirement that contains an importedRef (as an origin or as a ref).
Do not modify.importedRef
- the reference to the URL of an imported requirement.stash
- a Map<String, Object>
where implementations can store data temporarily. It's a
cache that is provided to all calls of fillDocumentDetails() of the same request
and the same descriptor.Copyright © 2021 Play SQL. All rights reserved.