Uses of Class
com.almworks.jira.structure.api.forest.ForestSpec

Packages that use ForestSpec

Package	Description
com.almworks.jira.structure.api.attribute	This package provides Attribute API.
com.almworks.jira.structure.api.attribute.subscription
com.almworks.jira.structure.api.effectbatch
com.almworks.jira.structure.api.effector
com.almworks.jira.structure.api.effector.process
com.almworks.jira.structure.api.export
com.almworks.jira.structure.api.forest
com.almworks.jira.structure.api.generator

Uses of ForestSpec in com.almworks.jira.structure.api.attribute

Methods in com.almworks.jira.structure.api.attribute with parameters of type ForestSpec

Modifier and Type	Method	Description
RowValues	StructureAttributeService.getAttributeValues(ForestSpec spec, boolean strictSpec, LongList rows, Collection<? extends AttributeSpec<?>> attributes, Consumer<ValuesMeta> metaConsumer)	Loads and returns attribute values as RowValues.
default RowValues	StructureAttributeService.getAttributeValues(ForestSpec spec, LongList rows, Collection<? extends AttributeSpec<?>> attributes)	Retrieves values for the given sets of attributes and rows.
RowValuesWithUpdateChecker	StructureAttributeService.getAttributeValuesWithUpdateChecker(ForestSpec spec, LongList rows, Collection<? extends AttributeSpec<?>> attributes)	Loads the values for the given rows and attributes, plus provides an instance of AttributeUpdateChecker, which can be used to detect that the values may have changed and another loading is needed.
RowValuesWithUpdateChecker	StructureAttributeService.getAttributeValuesWithUpdateChecker(ItemForest forest, LongList rows, Collection<? extends AttributeSpec<?>> attributes, ForestSpec baseForestSpec)	Loads the values for the given rows and attributes, plus provides an instance of AttributeUpdateChecker, which can be used to detect that the values may have changed and another loading is needed.
ConsistentRowValues	StructureAttributeService.getConsistentAttributeValues(ForestSpec spec, boolean strictSpec, Function<ItemForest,LongList> rowsSupplier, Collection<? extends AttributeSpec<?>> attributes)	Performs consistent loading of values for the given rows and attributes.
default ConsistentRowValues	StructureAttributeService.getConsistentAttributeValues(ForestSpec spec, Function<ItemForest,LongList> rowsSupplier, Collection<? extends AttributeSpec<?>> attributes)	Performs consistent loading of values for the given rows and attributes.
boolean	StructureAttributeService.hasUpdate(ForestSpec spec, LongList rows, Collection<? extends AttributeSpec<?>> attributes, ValuesMeta loadMeta)	This method checks if there may have been updates in the system since some previous loading of the given attributes.
void	StructureAttributeService.loadAttributeValues(ForestSpec spec, boolean strictSpec, LongList rows, Collection<? extends AttributeSpec<?>> attributes, AttributeValuesReceiver receiver)	This method loads values for the given sets of attributes and rows.
default void	StructureAttributeService.loadAttributeValues(ForestSpec spec, LongList rows, Collection<? extends AttributeSpec<?>> attributes, AttributeValuesReceiver receiver)	Loads values for the given sets of attributes and rows.

Uses of ForestSpec in com.almworks.jira.structure.api.attribute.subscription

Methods in com.almworks.jira.structure.api.attribute.subscription that return ForestSpec

Modifier and Type	Method	Description
ForestSpec	AttributeSubscription.getForest()	Returns the forest spec currently set in this subscription.

Methods in com.almworks.jira.structure.api.attribute.subscription with parameters of type ForestSpec

Modifier and Type	Method	Description
AttributeSubscriptionPatch	AttributeSubscriptionPatch.setForest(ForestSpec forestSpec)

Uses of ForestSpec in com.almworks.jira.structure.api.effectbatch

Fields in com.almworks.jira.structure.api.effectbatch declared as ForestSpec

Modifier and Type	Field	Description
final ForestSpec	EffectBatch.spec

Constructors in com.almworks.jira.structure.api.effectbatch with parameters of type ForestSpec

Modifier	Constructor	Description
	EffectBatch(ForestSpec spec, DataVersion version, LongIterable movedRows, RowsToReplace redoReplace, RowsToReplace undoReplace, List<EffectPair> effects)

Uses of ForestSpec in com.almworks.jira.structure.api.effector

Methods in com.almworks.jira.structure.api.effector that return ForestSpec

Modifier and Type	Method	Description
ForestSpec	EffectorContext.getForestSpec()	Returns the forest spec processed by the current effector invocation.

Uses of ForestSpec in com.almworks.jira.structure.api.effector.process

Methods in com.almworks.jira.structure.api.effector.process with parameters of type ForestSpec

Modifier and Type	Method	Description
long	EffectorProcessManager.startProcess(String moduleKey, Map<String,Object> parameters, ForestSpec forestSpec, boolean requiresConfirmation)	Starts a one-off effector process.
void	EffectorProcessManager.validateStartProcess(String moduleKey, Map<String,Object> parameters, ForestSpec forestSpec)	Checks whether an effector process can be started, as if by calling EffectorProcessManager.startProcess(String, Map, ForestSpec, boolean), without actually starting it.

Uses of ForestSpec in com.almworks.jira.structure.api.export

Methods in com.almworks.jira.structure.api.export that return ForestSpec

Modifier and Type	Method	Description
ForestSpec	ExportRequestContext.getForestSpec()	Returns the forest spec being exported.

Uses of ForestSpec in com.almworks.jira.structure.api.forest

Methods in com.almworks.jira.structure.api.forest that return ForestSpec

Modifier and Type	Method	Description
ForestSpec	ForestSpec.Builder.build()
static ForestSpec	ForestSpec.clipboard(String sessionId)	Constructs ForestSpec that represents a user's clipboard.
static ForestSpec	ForestSpec.fromRest(RestForestSpec rfs)	This method can be used to restore a forest spec from a REST transfer object.
ForestSpec	ForestSpec.getLastTransformedSpec()	For a forest spec with transformations, returns the forest spec without the last used transformation.
ForestSpec	ForestSpec.getUnsecured()	Returns the same forest spec, but with secured flag turned off.
ForestSpec	ForestSpec.getUntransformedSpec()	Returns the same forest spec but without transformations.
ForestSpec	ForestSpec.secure(String userKey)	Creates a new ForestSpec that is secured for the specified user.
static ForestSpec	ForestSpec.skeleton(long structureId)	Constructs ForestSpec that represents a structure with no dynamic content.
static ForestSpec	ForestSpec.sQuery(String type, String query)	Constructs ForestSpec that represents a structured query.
static ForestSpec	ForestSpec.structure(long structureId)	Constructs ForestSpec that represents a structure.
static ForestSpec	ForestSpec.structure(long structureId, ApplicationUser user)	Constructs ForestSpec that represents a structure.
ForestSpec	ForestSpec.transform(String module, Map<String,Object> params)	Creates a transformed ForestSpec that adds a single transformation to the result of the original forest spec.
static ForestSpec	ForestSpec.unsecuredStructure(long structureId)	Constructs ForestSpec that represents a structure.
static ForestSpec	ForestSpec.version(long structureId, int version)	Constructs ForestSpec that represents a historical version of a structure.
ForestSpec	ForestSpec.withoutTitle()	Returns the same forest spec but without title option.
ForestSpec	ForestSpec.withTitle()	Returns the same forest spec but with title option.

Methods in com.almworks.jira.structure.api.forest with parameters of type ForestSpec

Modifier and Type	Method	Description
static ForestSpec.Builder	ForestSpec.builder(ForestSpec spec)	Creates a new build that can be used to adjust a given ForestSpec.
String	ForestService.getDisplayName(ForestSpec spec)	Suggests a user-readable name fo the given forest spec.
ForestSource	ForestService.getForestSource(ForestSpec spec)	Creates a forest source based on the forest spec.
T	ForestSpec.Visitor.visitClipboard(ForestSpec clipboardSpec)
T	ForestSpec.Visitor.visitSecured(ForestSpec securedSpec)
T	ForestSpec.Visitor.visitSQuery(ForestSpec querySpec)
T	ForestSpec.Visitor.visitStructure(ForestSpec structureSpec)
T	ForestSpec.Visitor.visitTransformation(ForestSpec transformSpec)

Constructors in com.almworks.jira.structure.api.forest with parameters of type ForestSpec

Modifier	Constructor	Description
	Builder(ForestSpec spec)	Creates a builder and copies all parameters from the given spec.

Uses of ForestSpec in com.almworks.jira.structure.api.generator

Methods in com.almworks.jira.structure.api.generator that return ForestSpec

Modifier and Type	Method	Description
ForestSpec	StructureGenerator.GenerationContext.getForestSpec()	Returns the forest spec of the forest being generated.
ForestSpec	StructureGenerator.GenerationContext.getForestSpecBeingTransformed()