com.almworks.jira.structure.api.property

Interface StructurePropertyService

public interface StructurePropertyService

Holds properties associated with the particular structure

Method Summary

Modifier and Type	Method and Description
Set<String>	getAllKeys(long structureId)
String	getString(long structureId, String key, String defaultValue)
void	removeAllProperties(long structureId)
void	setValue(long structureId, String key, String value) Stores value for the given structure and key Notes: 1.

Method Detail

getString

@Nullable
String getString(long structureId,
                           @NotNull
                           String key,
                           @Nullable
                           String defaultValue)

setValue

void setValue(long structureId,
              @NotNull
              String key,
              @Nullable
              String value)

Stores value for the given structure and key Notes: 1. There is no structure existence or permissions checks 2. Existing values will be overridden 3. setting 'null' will remove database entry

Parameters:

structureId - id of the structure, structure may not exist

key - should be <= 170 chars in length

value - length is not limited, but specific DB rules for storing long text values may apply

getAllKeys

@NotNull
Set<String> getAllKeys(long structureId)

removeAllProperties

void removeAllProperties(long structureId)