| Package | Description |
|---|---|
| com.almworks.jira.structure.api.error | |
| com.almworks.jira.structure.api.folder | |
| com.almworks.jira.structure.api.forest | |
| com.almworks.jira.structure.api.forest.action | |
| com.almworks.jira.structure.api.forest.raw | |
| com.almworks.jira.structure.api.generator | |
| com.almworks.jira.structure.api.item | |
| com.almworks.jira.structure.api.query | |
| com.almworks.jira.structure.api.structure |
This package features
StructureManager service,
which is used to create structures and change their properties (but not the forest), and
Structure interface, which represents structures. |
| com.almworks.jira.structure.api.structure.history | |
| com.almworks.jira.structure.api.sync | |
| com.almworks.jira.structure.api.sync.util | |
| com.almworks.jira.structure.api.view |
| Modifier and Type | Method and Description |
|---|---|
StructureException |
StructureException.Builder.withLocalizedMessage(String messageKey,
Object... messageParameters) |
default StructureException |
StructureError.withLocalizedMessage(String messageKey,
Object... messageParameters)
A shortcut to calling the same method on
StructureException builder. |
StructureException |
StructureException.Builder.withMessage(String message) |
default StructureException |
StructureError.withMessage(String message)
A shortcut to calling the same method on
StructureException builder. |
StructureException |
StructureException.Builder.withoutMessage() |
default StructureException |
StructureError.withoutMessage()
A shortcut to calling the same method on
StructureException builder. |
| Modifier and Type | Method and Description |
|---|---|
long |
FolderManager.createFolder(Folder folder) |
void |
FolderManager.deleteFolder(long id) |
void |
FolderManager.updateFolder(long id,
Folder folder) |
| Modifier and Type | Method and Description |
|---|---|
<T> T |
ForestSpec.accept(ForestSpec.Visitor<T> visitor)
Applies
ForestSpec.Visitor to this spec. |
default ActionResult |
ForestSource.apply(ForestAction action)
Convenient method to call
ForestSource.apply(ForestAction, Map) with an empty parameter map. |
ActionResult |
ForestSource.apply(ForestAction action,
Map<String,Object> parameters)
Applies a forest action to this source.
|
void |
SQuerySkeletonFactory.createSkeleton(String query,
ItemForestBuilder itemForestBuilder) |
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) |
| Modifier and Type | Class and Description |
|---|---|
class |
StructureInteractionException |
| Modifier and Type | Method and Description |
|---|---|
abstract void |
ForestAction.accept(ForestAction.Visitor visitor) |
void |
ForestAction.Remove.accept(ForestAction.Visitor visitor) |
void |
ForestAction.Move.accept(ForestAction.Visitor visitor) |
void |
ForestAction.Add.accept(ForestAction.Visitor visitor) |
void |
ForestAction.Copy.accept(ForestAction.Visitor visitor) |
void |
ForestAction.Visitor.visit(ForestAction.Add add) |
void |
ForestAction.Visitor.visit(ForestAction.Copy copy) |
void |
ForestAction.Visitor.visit(ForestAction.Move move) |
void |
ForestAction.Visitor.visit(ForestAction.Remove remove) |
| Modifier and Type | Class and Description |
|---|---|
class |
ForestMergeStructureException |
| Modifier and Type | Method and Description |
|---|---|
boolean |
ArrayForest.addRow(long row,
long under,
long after)
Adds a single row at the specified position.
|
void |
ArrayForest.mergeForest(Forest forest,
long under,
long after)
Convenience method to call
ArrayForest.mergeForest(Forest, long, long, ForestChangeEventHandler) without event handler. |
void |
ArrayForest.mergeForest(Forest forest,
long under,
long after,
ForestChangeEventHandler eventHandler)
Merges another forest into this forest.
|
boolean |
ArrayForest.moveSubtree(long row,
long under,
long after)
Convenience method to call
ArrayForest.moveSubtree(long, long, long, ForestChangeEventHandler) without event handler. |
boolean |
ArrayForest.moveSubtree(long row,
long under,
long after,
ForestChangeEventHandler eventHandler)
Moves sub-tree rooted at the specified row to a position specified by
(under, after) coordinates. |
int |
ArrayForest.moveSubtreeAtIndex(int index,
long under,
long after,
ForestChangeEventHandler eventHandler)
Moves sub-tree rooted at the specified index to a position specified by
(under, after) coordinates. |
| Modifier and Type | Method and Description |
|---|---|
void |
StructureGenerator.EffectContext.effect(String explanation,
RunnableE<? extends StructureException> effect) |
| Modifier and Type | Method and Description |
|---|---|
long |
GeneratorManager.createGenerator(String moduleKey,
Map<String,Object> parameters,
Long owningStructure) |
long |
GeneratorManager.createTransientGenerator(String moduleKey,
Map<String,Object> parameters) |
void |
GeneratorManager.deleteGenerator(long id) |
GeneratorSpec |
GeneratorManager.getGenerator(long id) |
void |
GeneratorManager.updateGenerator(long id,
String moduleKey,
Map<String,Object> parameters,
Long owningStructure) |
| Modifier and Type | Method and Description |
|---|---|
StructureRow |
CreatableItemType.createDummyRow(long rowId,
long semantics,
Map<String,Object> values,
com.atlassian.jira.util.ErrorCollection errors) |
ItemIdentity |
CreatableItemType.createItem(Map<String,Object> values,
com.atlassian.jira.util.ErrorCollection errors) |
ItemIdentity |
StructureOwnedItemType.getOwnedItem(ItemIdentity itemId,
long structureId,
boolean copyIfSame)
Associate an item with a structure, or create a copy of the given item and associate the copy with the structure.
|
void |
UpdatableItemType.updateItem(ItemIdentity itemId,
Map<String,Object> values,
com.atlassian.jira.util.ErrorCollection errors) |
| Modifier and Type | Method and Description |
|---|---|
StructureQuery |
StructureQueryParser.parse(String query)
Parses
query and returns the corresponding StructureQuery. |
| Modifier and Type | Method and Description |
|---|---|
Structure |
StructureManager.copyStructure(Long structureId,
com.atlassian.jira.user.ApplicationUser newOwner,
boolean copyPermissions)
Copies the structure and the forest it contains into a new structure.
|
Structure |
StructureManager.copyStructureWithoutForest(Long structureId,
com.atlassian.jira.user.ApplicationUser newOwner,
boolean copyPermissions)
Copies the structure into a new structure - only the properties (such as name, description, permissions)
are copied, not the forest.
|
void |
StructureManager.deleteStructure(Long id)
Deletes the specified structure and its content.
|
Structure |
StructureManager.getStructure(Long structureId,
PermissionLevel requiredLevel)
Retrieves a structure given structure ID.
|
Structure |
Structure.saveChanges()
Call this method to save the changes made with
set... methods and update the database. |
| Modifier and Type | Method and Description |
|---|---|
ForestVersion |
HistoryService.getForestVersion(long structureId,
int version) |
| Modifier and Type | Method and Description |
|---|---|
protected abstract AbstractSynchronizer.SyncRunAuditEntry |
AbstractSynchronizer.doResync(SyncInstance instance,
ForestSource forestSource) |
protected abstract AbstractSynchronizer.SyncRunAuditEntry |
AbstractSynchronizer.doSync(SyncInstance instance,
IncrementalSyncData data,
ForestSource forestSource) |
Map<String,Object> |
Structure2xBackwardCompatibleSynchronizer.migrateParameters(byte[] params) |
static <P> P |
Structure2xBackwardCompatibleSynchronizer.SyncMigrationUtil.restoreStructure2xParameters(byte[] data,
Class<P> paramsClazz) |
void |
StructureSynchronizer.resync(SyncInstance instance,
ForestSource forestSource)
Perform full resync.
|
void |
AbstractSynchronizer.resync(SyncInstance instance,
ForestSource forestSource) |
void |
StructureSynchronizer.sync(SyncInstance instance,
IncrementalSyncData data,
ForestSource forestSource)
Perform incremental synchronization.
|
void |
AbstractSynchronizer.sync(SyncInstance instance,
IncrementalSyncData syncData,
ForestSource forestSource) |
| Modifier and Type | Method and Description |
|---|---|
static void |
SyncUtil.processUpdateError(StructureException exception,
SyncLogger slog,
StringBuilder errorMessage) |
String |
SyncLogger.warnStructureException(StructureException e)
Contains standard error descriptions for common StructureExceptions
|
| Modifier and Type | Method and Description |
|---|---|
static com.almworks.integers.LongLongMap |
SyncUtil.add(ForestSource ufs,
ForestAction.Add add) |
static com.almworks.integers.LongLongMap |
SyncUtil.add(ForestSource ufs,
ItemForest fragment,
long under,
long after)
Returns row ID replacements, if the add was successful; returns
null otherwise. |
static void |
SyncUtil.insert(ForestSource ufs,
ItemForestBuffer addedForest,
com.almworks.integers.LongList issues,
long under,
long after) |
static boolean |
SyncUtil.merge(ForestSource ufs,
RowManager rowManager,
long row,
long targetRow) |
static boolean |
SyncUtil.merge(ForestSource ufs,
RowManager rowManager,
long row,
long targetRow,
boolean followSymlinks) |
static boolean |
SyncUtil.merge(ForestSource ufs,
RowManager rowManager,
long row,
long targetRow,
boolean followSymlinks,
boolean removeRow,
com.almworks.integers.WritableLongLongMap mergedRows)
Merges the subtree of
row under targetRow. |
static long |
SyncUtil.move(ForestSource ufs,
com.almworks.integers.LongList rows,
long under,
long after,
boolean[] success) |
static long |
SyncUtil.move(ForestSource ufs,
com.almworks.integers.LongList rows,
long under,
long after,
boolean invalidMoveExpected,
boolean[] success) |
static void |
SyncUtil.processUpdateError(StructureException exception,
SyncLogger slog,
StringBuilder errorMessage) |
static void |
SyncUtil.remove(ForestSource ufs,
com.almworks.integers.LongList rows) |
static boolean |
SyncUtil.resolveMoveIntoOwnSubtree(long moveTo,
long row,
HierarchyHelper hh,
ForestSource ufs,
SyncLogger debugLog) |
| Modifier and Type | Method and Description |
|---|---|
void |
StructureViewManager.deleteView(Long viewId)
Deletes a view.
|
List<Structure> |
StructureViewManager.getAssociatedStructures(Long viewId)
Retrieves all structures that are "associated" with the specified view, i.e.
|
StructureView |
StructureViewManager.getView(Long viewId,
PermissionLevel requiredLevel)
Retrieves a view specified by the numeric view ID and checks if
the
current user has the specified access level for that view. |
ViewSettings |
StructureViewManager.getViewSettings(Long structureId)
Retrieves view settings for the specified structure.
|
StructureView |
StructureView.saveChanges()
Call this method to save the changes made with
set... methods and update the database. |
void |
StructureViewManager.setDefaultViewSettings(ViewSettings settings)
Updates the global default view settings, which apply to all structure that don't have
view settings overridden.
|
void |
StructureViewManager.setViewSettings(Long structureId,
ViewSettings settings)
Updates view settings for the specified structure.
|
Copyright © 2017 ALM Works. All Rights Reserved.