com.almworks.jira.structure.api.column.ColumnRequestContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of structure-api Show documentation

Public API for the Structure Plugin for JIRA

There is a newer version: 17.25.3

package com.almworks.jira.structure.api.column;

import com.almworks.jira.structure.api2g.attribute.AttributeSpec;
import com.atlassian.annotations.PublicApi;
import org.jetbrains.annotations.Nullable;

/**
 * A subtype of {@link AttributeContext} passed into calls to
 * {@link com.almworks.jira.structure.api.column.data.IssueDataProvider IssueDataProvider} and
 * {@link com.almworks.jira.structure.api.column.export.ExportRendererProvider ExportRendererProvider}.
 *
 * Has a method for requesting {@link Aggregate} calculation.
 *
 * todo javadocs
 *
 * @see AttributeContext
 * @see ColumnRenderContext
 */
@PublicApi
public interface ColumnRequestContext extends AttributeContext {
  /**
   * Require an {@link Aggregate} to be calculated for this request. The result of the aggregation can later be
   * retrieved from the {@link ColumnRenderContext render context}.
   * @param aggregate The aggregate. Passing {@code null} allowed and has no effect.
   * @see ColumnRenderContext#getValues()
   * @see Aggregate
   */
  void requireAttribute(@Nullable AttributeSpec attribute);
}