com.almworks.jira.structure.api.generator

Interface StructureGenerator

All Known Subinterfaces:

ActionHandlingGenerator<T>, ActionHandlingGenerator.Extender, ActionHandlingGenerator.Grouper, ActionHandlingGenerator.Inserter, ActionHandlingGenerator.Sorter, ConfigurableGenerator, StructureGenerator.Extender, StructureGenerator.Filter, StructureGenerator.Grouper, StructureGenerator.Inserter, StructureGenerator.Sorter

All Known Implementing Classes:

AbstractGenerator, AbstractGenerator.Extender, AbstractGenerator.Filter, AbstractGenerator.Grouper, AbstractGenerator.Inserter, AbstractGenerator.Sorter

@PublicSpi
public interface StructureGenerator

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StructureGenerator.ApplicabilityChecker
static interface	StructureGenerator.Context
static interface	StructureGenerator.EffectContext
static interface	StructureGenerator.Extender
static interface	StructureGenerator.Filter
static interface	StructureGenerator.GenerationContext
static interface	StructureGenerator.Grouper
static interface	StructureGenerator.HandlingContext
static interface	StructureGenerator.Inserter An implementor inserts new items into the containing structure.
static interface	StructureGenerator.ItemChangeFilterContext
static interface	StructureGenerator.Sorter

Method Summary

Modifier and Type	Method and Description
void	addDefaultFormParameters(Map<String,Object> form)
void	addParametersForSummary(Map<String,Object> parameters, Map<String,Object> summaryParameters)
void	addParametersToForm(Map<String,Object> parameters, Map<String,Object> form)
Map<String,Object>	buildParametersFromForm(Map<String,Object> form, ErrorCollection errors)
boolean	isAvailable()

Method Detail

addDefaultFormParameters

void addDefaultFormParameters(@NotNull
                              Map<String,Object> form)
                       throws GeneratorUnavailableException

Throws:

GeneratorUnavailableException

addParametersToForm

void addParametersToForm(@NotNull
                         Map<String,Object> parameters,
                         @NotNull
                         Map<String,Object> form)
                  throws GeneratorUnavailableException

Throws:

GeneratorUnavailableException

buildParametersFromForm

@NotNull
Map<String,Object> buildParametersFromForm(@NotNull
                                                    Map<String,Object> form,
                                                    @NotNull
                                                    ErrorCollection errors)
                                             throws GeneratorUnavailableException

Throws:

GeneratorUnavailableException

addParametersForSummary

void addParametersForSummary(@NotNull
                             Map<String,Object> parameters,
                             @NotNull
                             Map<String,Object> summaryParameters)

isAvailable

boolean isAvailable()