com.almworks.jira.structure.api.error

Enum StructureErrors

Object

Enum<StructureErrors>

StructureErrors

All Implemented Interfaces:

StructureError, Serializable, Comparable<StructureErrors>

@PublicApi
public enum StructureErrors
extends Enum<StructureErrors>
implements StructureError

StructureErrors is a enumeration of all public Structure errors.

See Also:

StructureError, StructureException

Nested Class Summary

Nested classes/interfaces inherited from interface StructureError

StructureError.CodeRange

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARCHIVED_STRUCTURE_EDIT_DENIED Trying to edit archived structure.
AUTOMATION_ACCESS_DENIED The user does not have access to automation feature.
AUTOMATION_FAILED Automation feature failed.
CONSISTENT_OPERATION_FAILED An operation that implements optimistic locking to achieve consistent result failed because of too many cycles in the optimistic lock.
CREATE_ITEM_FAILED Structure attempted to create a new item but something failed in the corresponding module.
DECISION_REQUIRED Indicates that there are additional decisions that need to be made by the user to execute the operations.
EFFECTOR_EXECUTION_DENIED The user does not have access to execute effectors
FOREST_CHANGE_PROHIBITED_BY_PARENT_PERMISSIONS When a structure has "requires editable parent" flag on, and the attempted operation is under an item that the user does not have the edit access to.
FOREST_SOURCE_ACTION_FAILED Generic update error for actions applied to a forest source.
GENERIC_ERROR Non-specific error.
INVALID_FOREST_OPERATION Invalid under/after/before coordinates used to change the forest, or other parameters used to make a forest operation.
INVALID_PARAMETER Invalid parameter used (either in operation or in settings of a synchronizer or generator or other entity)
ITEM_EDIT_DENIED Attempting to edit an item without permission.
ITEM_NOT_EXISTS_OR_NOT_ACCESSIBLE Cannot access an item because either it is missing or the user does not have access to it.
JIRA_ADMIN_DENIED The user does not have JIRA Administrators permission.
JOB_NOT_EXISTS The background job is not available.
LICENSE_PROBLEM Problem with Structure license or extension license, which prevents operation from being executed.
LOCK_FAILED Internal problem with Structure locking mechanism.
MODULE_ERROR An extension module is throwing an exception or fails to get linked to.
NOT_ALLOWED_TO_CREATE_STRUCTURE The user does not have Create Structure permission.
PERSPECTIVE_CREATION_DENIED The user does not have permissions to create perspectives.
PROJECT_NOT_ENABLED_FOR_STRUCTURE Trying to do something with an issue from a project that is not enabled for Structure.
SIGNATURE_MISMATCH Signature has changed and the client needs to reload the initial data before applying updates.
STRUCTURE_ADMIN_DENIED The user does not have Control access level to the structure.
STRUCTURE_AUTOMATION_EDIT_DENIED The user does not have permission to configure automation in the structure.
STRUCTURE_EDIT_DENIED The user does not have Edit access level to the structure.
STRUCTURE_NOT_EXISTS_OR_NOT_ACCESSIBLE Trying to access a structure that does not exist, or the user has no read access to it.
STRUCTURE_OWNER_EDIT_DENIED Trying to change structure's owner while not being an admin.
STRUCTURE_PLUGIN_ACCESS_DENIED The user does not have access to Structure plugin functionality.
SUBSCRIPTION_NOT_EXISTS_OR_NOT_ACCESSIBLE Cannot access an attribute subscription because either it is missing or the user does not have access to it.
UNAVAILABLE_MODULE An extension module (item type, attribute loader, etc) is expected to exist in the system but was missing.
UNSUPPORTED_FOREST_SOURCE_OPERATION Unsupported operation on ForestSource — for example, trying to make changes on a read-only source.
UPDATE_ITEM_FAILED Item update failed.
VIEW_ADMIN_DENIED The user does not have Control permission on the view.
VIEW_CREATION_DENIED The user does not have permissions to create views.
VIEW_EDIT_DENIED The user does not have Edit permission on the view.
VIEW_NOT_EXISTS_OR_NOT_ACCESSIBLE Inaccessible view.

Method Summary

Modifier and Type	Method and Description
StructureErrorCategory	getCategory() Returns error category.
int	getCode() Returns error code.
String	toString()
static StructureErrors	valueOf(String name) Returns the enum constant of this type with the specified name.
static StructureErrors[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface StructureError

builder, causedBy, forIssue, forItem, forRow, forStructure, forView, is, isOneOf, isOneOf, name, withLocalizedMessage, withMessage, withoutMessage

Enum Constant Detail

GENERIC_ERROR

public static final StructureErrors GENERIC_ERROR

Non-specific error. The meaning can be derived only from the error message and other parameters.

Implementation note: try to avoid using it and use a specific one instead.

LICENSE_PROBLEM

public static final StructureErrors LICENSE_PROBLEM

Problem with Structure license or extension license, which prevents operation from being executed.

LOCK_FAILED

public static final StructureErrors LOCK_FAILED

Internal problem with Structure locking mechanism.

INVALID_PARAMETER

public static final StructureErrors INVALID_PARAMETER

Invalid parameter used (either in operation or in settings of a synchronizer or generator or other entity)

DECISION_REQUIRED

public static final StructureErrors DECISION_REQUIRED

Indicates that there are additional decisions that need to be made by the user to execute the operations. Thrown from UpdatableForestSource.update()

FOREST_SOURCE_ACTION_FAILED

public static final StructureErrors FOREST_SOURCE_ACTION_FAILED

Generic update error for actions applied to a forest source. Includes generic failures caused by forest configuration and unexpected failures from trying to apply effects to items.

UPDATE_ITEM_FAILED

public static final StructureErrors UPDATE_ITEM_FAILED

Item update failed. The related item can be retrieved from StructureException.getItem().

CREATE_ITEM_FAILED

public static final StructureErrors CREATE_ITEM_FAILED

Structure attempted to create a new item but something failed in the corresponding module.

FOREST_CHANGE_PROHIBITED_BY_PARENT_PERMISSIONS

public static final StructureErrors FOREST_CHANGE_PROHIBITED_BY_PARENT_PERMISSIONS

When a structure has "requires editable parent" flag on, and the attempted operation is under an item that the user does not have the edit access to.

PROJECT_NOT_ENABLED_FOR_STRUCTURE

public static final StructureErrors PROJECT_NOT_ENABLED_FOR_STRUCTURE

Trying to do something with an issue from a project that is not enabled for Structure.

STRUCTURE_NOT_EXISTS_OR_NOT_ACCESSIBLE

public static final StructureErrors STRUCTURE_NOT_EXISTS_OR_NOT_ACCESSIBLE

Trying to access a structure that does not exist, or the user has no read access to it.

NOT_ALLOWED_TO_CREATE_STRUCTURE

public static final StructureErrors NOT_ALLOWED_TO_CREATE_STRUCTURE

The user does not have Create Structure permission.

STRUCTURE_ADMIN_DENIED

public static final StructureErrors STRUCTURE_ADMIN_DENIED

The user does not have Control access level to the structure.

STRUCTURE_EDIT_DENIED

public static final StructureErrors STRUCTURE_EDIT_DENIED

The user does not have Edit access level to the structure.

JIRA_ADMIN_DENIED

public static final StructureErrors JIRA_ADMIN_DENIED

The user does not have JIRA Administrators permission.

STRUCTURE_PLUGIN_ACCESS_DENIED

public static final StructureErrors STRUCTURE_PLUGIN_ACCESS_DENIED

The user does not have access to Structure plugin functionality.

ARCHIVED_STRUCTURE_EDIT_DENIED

public static final StructureErrors ARCHIVED_STRUCTURE_EDIT_DENIED

Trying to edit archived structure.

STRUCTURE_OWNER_EDIT_DENIED

public static final StructureErrors STRUCTURE_OWNER_EDIT_DENIED

Trying to change structure's owner while not being an admin.

STRUCTURE_AUTOMATION_EDIT_DENIED

public static final StructureErrors STRUCTURE_AUTOMATION_EDIT_DENIED

The user does not have permission to configure automation in the structure.

VIEW_NOT_EXISTS_OR_NOT_ACCESSIBLE

public static final StructureErrors VIEW_NOT_EXISTS_OR_NOT_ACCESSIBLE

Inaccessible view.

VIEW_ADMIN_DENIED

public static final StructureErrors VIEW_ADMIN_DENIED

The user does not have Control permission on the view.

VIEW_EDIT_DENIED

public static final StructureErrors VIEW_EDIT_DENIED

The user does not have Edit permission on the view.

VIEW_CREATION_DENIED

public static final StructureErrors VIEW_CREATION_DENIED

The user does not have permissions to create views.

PERSPECTIVE_CREATION_DENIED

public static final StructureErrors PERSPECTIVE_CREATION_DENIED

The user does not have permissions to create perspectives.

ITEM_EDIT_DENIED

public static final StructureErrors ITEM_EDIT_DENIED

Attempting to edit an item without permission. When it comes to issues, the error may be reported not only when the user does not have permissions, but when JIRA prohibits editing the issue based on workflow.

AUTOMATION_ACCESS_DENIED

public static final StructureErrors AUTOMATION_ACCESS_DENIED

The user does not have access to automation feature.

EFFECTOR_EXECUTION_DENIED

public static final StructureErrors EFFECTOR_EXECUTION_DENIED

The user does not have access to execute effectors

JOB_NOT_EXISTS

public static final StructureErrors JOB_NOT_EXISTS

The background job is not available.

ITEM_NOT_EXISTS_OR_NOT_ACCESSIBLE

public static final StructureErrors ITEM_NOT_EXISTS_OR_NOT_ACCESSIBLE

Cannot access an item because either it is missing or the user does not have access to it. Specific item must be supplied via StructureException.getItem().

SUBSCRIPTION_NOT_EXISTS_OR_NOT_ACCESSIBLE

public static final StructureErrors SUBSCRIPTION_NOT_EXISTS_OR_NOT_ACCESSIBLE

Cannot access an attribute subscription because either it is missing or the user does not have access to it.

See Also:

AttributeSubscriptionService

INVALID_FOREST_OPERATION

public static final StructureErrors INVALID_FOREST_OPERATION

Invalid under/after/before coordinates used to change the forest, or other parameters used to make a forest operation. The error can be fixed by changing the parameters of the forest operation.

UNSUPPORTED_FOREST_SOURCE_OPERATION

public static final StructureErrors UNSUPPORTED_FOREST_SOURCE_OPERATION

Unsupported operation on ForestSource — for example, trying to make changes on a read-only source. The error cannot be fixed on the same forest source.

UNAVAILABLE_MODULE

public static final StructureErrors UNAVAILABLE_MODULE

An extension module (item type, attribute loader, etc) is expected to exist in the system but was missing.

MODULE_ERROR

public static final StructureErrors MODULE_ERROR

An extension module is throwing an exception or fails to get linked to.

SIGNATURE_MISMATCH

public static final StructureErrors SIGNATURE_MISMATCH

Signature has changed and the client needs to reload the initial data before applying updates.

AUTOMATION_FAILED

public static final StructureErrors AUTOMATION_FAILED

Automation feature failed.

CONSISTENT_OPERATION_FAILED

public static final StructureErrors CONSISTENT_OPERATION_FAILED

An operation that implements optimistic locking to achieve consistent result failed because of too many cycles in the optimistic lock.

Method Detail

values

public static StructureErrors[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StructureErrors c : StructureErrors.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StructureErrors valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCode

public int getCode()

Description copied from interface: StructureError

Returns error code.

Specified by:

getCode in interface StructureError

getCategory

public StructureErrorCategory getCategory()

Description copied from interface: StructureError

Returns error category.

Specified by:

getCategory in interface StructureError

toString

public String toString()

Overrides:

toString in class Enum<StructureErrors>