com.almworks.jira.structure.api.column.ColumnRenderContext 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.RowValues;
import com.atlassian.annotations.PublicApi;
import org.jetbrains.annotations.NotNull;

/**
 * A subtype of {@link AttributeContext} passed into calls to
 * {@link com.almworks.jira.structure.api.column.data.IssueDataField IssueDataField} and
 * {@link com.almworks.jira.structure.api.column.export.ExportRenderer ExportRenderer}.
 *
 * Has a method for obtaining the aggregate calculation {@link AggregateResult result}.
 *
 * todo javadocs
 *
 * @see AttributeContext
 * @see ColumnRequestContext
 */
@PublicApi
public interface ColumnRenderContext extends AttributeContext {

  // todo review if this method is needed (we have ExportRow.get()), and if it's ok to remove this interface altogether
  /**
   * Returns the {@link AggregateResult} that contains the results for all
   * {@link com.almworks.jira.structure.api.aggregate.Aggregate aggregates} previously required by calling
   * {@link ColumnRequestContext#addAttribute(com.almworks.jira.structure.api.aggregate.Aggregate)
   * ColumnRequestContext.prepareAggregate()} and all the issues associated with the current request.
   *
   * @return The aggregation result, never {@code null}.
   * @see ColumnRequestContext#addAttribute(com.almworks.jira.structure.api.aggregate.Aggregate)
   * @see AggregateResult
   */
  @NotNull
  RowValues getValues();
}