@PublicApi public interface ExportRequestContext extends AttributeContext
A context that is passed to ExportRenderer
and ExportRendererProvider
during preparation
phase of the export.
The main capability of this interface is to allow the renderer to request calculation of specific attributes
via requireAttribute(com.almworks.jira.structure.api.attribute.AttributeSpec<?>)
methods. These attributes will be available later during the main phase of the
export.
Additionally, a renderer may prepare some data and store it in the context.
AttributeContext
,
ExportRenderContext
Modifier and Type | Method and Description |
---|---|
ForestSpec |
getForestSpec()
Returns the forest spec being exported.
|
void |
requireAttribute(AttributeSpec<?> attribute)
Require an attribute to be calculated for this request.
|
getBaseStructureId, getBaseUrl, getI18n, getI18nHelper, getLoadTimeMillis, getLoadTimeNanos, getLocale, getObject, getTimeZone, getUser, putObject
void requireAttribute(@Nullable AttributeSpec<?> attribute)
Require an attribute to be calculated for this request. The values can later be
retrieved from ExportRow.get(AttributeSpec)
or ExportRenderContext.getValues()
.
attribute
- The attribute specification. Passing null
allowed and has no effect.ExportRow.get(AttributeSpec)
,
ExportRenderContext.getValues()
,
AttributeSpec
@NotNull ForestSpec getForestSpec()
Copyright © 2024 Tempo Software. All Rights Reserved.