@PublicApi public interface StructureRow
StructureRow instances represent rows, main building blocks of a forest.
A row has the following properties:
rowIDis the unique ID of the row.
itemIDis the ID of the item that is displayed in this row.
semanticsis the semantic code of the relationship between the row and its parent. Currently, semantics are not supported and are zero most of the times.
creatorIdare additional properties, specified only for transient rows — see
Note that a single forest may contain the same item in multiple places, but all rows will be unique.
Rows are immutable. Persistent rows get stored in the database and are never updated nor deleted. Temporary rows get cleared when JIRA instance restarts. Garbage collection for rows is planned for the future.
StructureRow is a temporary object and must not be cached or leaked outside the current request, because it
stores the result of access check to the item for the current user.
|Modifier and Type||Interface and Description|
|Modifier and Type||Method and Description|
Tries to resolve the item based on its ID, that is, get an object that represents this item.
Returns item ID for the item shown in this row.
Returns row ID, a positive number.
Returns row's semantics.
static final StructureRow ROW_ZERO
@NotNull ItemIdentity getItemId()
@Nullable <I> I getItem(@NotNull Class<I> itemClass)
Tries to resolve the item based on its ID, that is, get an object that represents this item. Resolution includes checking the current user's access to that item, unless the row is created with an additional flag indicating that the access check should be skipped.
This method may return
null in many different cases:
StructureRowwas created with the
I- type of item's objects
itemClass- expected class of the item's object
Copyright © 2023 ALM Works. All Rights Reserved.