Package com.almworks.jira.structure.api.item.generic

Class GenericItemType

Object

GenericItemType

All Implemented Interfaces:

BulkAccessCheckingItemType, CreatableItemType, DeadItemsCheckingItemType, StructureItemType<GenericItem>, StructureOwnedItemType, UpdatableItemType

@PublicApi
public class GenericItemType
extends Object
implements StructureItemType<GenericItem>, CreatableItemType, UpdatableItemType, StructureOwnedItemType, DeadItemsCheckingItemType, BulkAccessCheckingItemType

GenericItemType is responsible for generic items support in Structure plugin.

It is used as a reference in structure-item-type module that declares generic item type.

Field Summary

Fields

Modifier and Type	Field	Description
protected final GenericItemManager	myGenericItemManager
protected final GenericItemService	myGenericItemService
protected final StructurePluginHelper	myHelper
static final long	NEW_ITEM_ID

Constructor Summary

Constructors

Constructor	Description
GenericItemType(GenericItemService genericItemService, GenericItemManager genericItemManager, StructurePluginHelper helper)

Method Summary

Modifier and Type	Method	Description
GenericItem	accessItem(ItemIdentity itemId)	Does not check for permissions.
StructureRow	createDummyRow(long rowId, long semantics, Map<String,Object> values, ErrorCollection errors)
ItemIdentity	createItem(Map<String,Object> values, ErrorCollection errors)
void	filterDead(ItemIdentitySet items, ItemIdentitySet deadCollector)	Item is considered dead, if the item ID is guaranteed to never be valid again.
void	filterInaccessible(ItemIdentitySet items, ApplicationUser user, boolean overrideSecurity, ItemIdentitySet inaccessibleCollector)
ItemIdentity	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	init(ModuleDescriptor descriptor)
boolean	isVisible(GenericItem item, ApplicationUser user)
protected void	readItemValues(GenericItem.Builder builder, Map<String,Object> values, GenericItem existing, ErrorCollection errors)
void	updateItem(ItemIdentity itemId, Map<String,Object> values, ErrorCollection errors)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NEW_ITEM_ID

public static final long NEW_ITEM_ID

See Also:

• Constant Field Values

myGenericItemService

protected final GenericItemService myGenericItemService

myGenericItemManager

protected final GenericItemManager myGenericItemManager

myHelper

protected final StructurePluginHelper myHelper

Constructor Details

GenericItemType

public GenericItemType(GenericItemService genericItemService,
 GenericItemManager genericItemManager,
 StructurePluginHelper helper)

Method Details

init

@Internal
public void init(ModuleDescriptor descriptor)

accessItem

@Nullable
public GenericItem accessItem(@NotNull
 ItemIdentity itemId)

Description copied from interface: StructureItemType

Does not check for permissions.

Specified by:

accessItem in interface StructureItemType<GenericItem>

Returns:

isVisible

public boolean isVisible(@NotNull
 GenericItem item,
 @Nullable
 ApplicationUser user)

Specified by:

isVisible in interface StructureItemType<GenericItem>

createDummyRow

public StructureRow createDummyRow(long rowId,
 long semantics,
 Map<String,Object> values,
 ErrorCollection errors)
                            throws StructureException

Specified by:

createDummyRow in interface CreatableItemType

Throws:

StructureException

createItem

public ItemIdentity createItem(Map<String,Object> values,
 ErrorCollection errors)
                        throws StructureException

Specified by:

createItem in interface CreatableItemType

Throws:

StructureException

updateItem

public void updateItem(ItemIdentity itemId,
 Map<String,Object> values,
 ErrorCollection errors)
                throws StructureException

Specified by:

updateItem in interface UpdatableItemType

Throws:

StructureException

getOwnedItem

@NotNull
public ItemIdentity getOwnedItem(@NotNull
 ItemIdentity itemId,
 long structureId,
 boolean copyIfSame)
                          throws StructureException

Description copied from interface: StructureOwnedItemType

Associate an item with a structure, or create a copy of the given item and associate the copy with the structure.

Specified by:

getOwnedItem in interface StructureOwnedItemType

Parameters:

itemId - The item ID.

structureId - The structure ID.

copyIfSame - Create a copy of the item even if it is already associated with the given structure.

Returns:

The ID of the associated item.

Throws:

StructureException

filterDead

public void filterDead(ItemIdentitySet items,
 ItemIdentitySet deadCollector)

Description copied from interface: DeadItemsCheckingItemType

Item is considered dead, if the item ID is guaranteed to never be valid again.

Specified by:

filterDead in interface DeadItemsCheckingItemType

Parameters:

items - items to look up for dead ones

deadCollector - collection to add dead items to.

filterInaccessible

public void filterInaccessible(ItemIdentitySet items,
 ApplicationUser user,
 boolean overrideSecurity,
 ItemIdentitySet inaccessibleCollector)

Specified by:

filterInaccessible in interface BulkAccessCheckingItemType

readItemValues

protected void readItemValues(@NotNull
 GenericItem.Builder builder,
 @Nullable
 Map<String,Object> values,
 @Nullable
 GenericItem existing,
 @NotNull
 ErrorCollection errors)