com.atlassian.jira.config
Interface ConstantsManager

All Known Implementing Classes:
DefaultConstantsManager

public interface ConstantsManager

Manager for issue types, statuses, priorities and resolutions. This manager is responsible for caching these constants as well as all the usual update, delete, add operations in the database.


Field Summary
static java.lang.String ALL_ISSUE_TYPES
          Used to retrieve all IssueTypes.
static java.lang.String ALL_STANDARD_ISSUE_TYPES
          Used to retrieve a standard IssueTypes.
static java.lang.String ALL_SUB_TASK_ISSUE_TYPES
          Used to retrieve a subtask IssueTypes.
static java.lang.String ISSUE_TYPE_CONSTANT_TYPE
          Used in the generic getConstant(String, String) method
static java.lang.String PRIORITY_CONSTANT_TYPE
          Used in the generic getConstant(String, String) method
static java.lang.String RESOLUTION_CONSTANT_TYPE
          Used in the generic getConstant(String, String) method
static java.lang.String STATUS_CONSTANT_TYPE
          Used in the generic getConstant(String, String) method
 
Method Summary
 boolean constantExists(java.lang.String constantType, java.lang.String name)
          Checks if a constant exists.
 java.util.List convertToConstantObjects(java.lang.String constantType, java.util.Collection ids)
          Converts the list of ids to the objects of appropriate types
 org.ofbiz.core.entity.GenericValue createIssueType(java.lang.String name, java.lang.Long sequence, java.lang.String style, java.lang.String description, java.lang.String iconurl)
          Note this metod does not validate the input - i.e.
 java.util.List<java.lang.String> expandIssueTypeIds(java.util.Collection<java.lang.String> issueTypeIds)
          Converts the 'special' ids of issue types to a list of issue type ids For example, converts a special id to a list of all sub-task issue types Also see ALL_STANDARD_ISSUE_TYPES, ALL_SUB_TASK_ISSUE_TYPES and ALL_ISSUE_TYPES.
 java.util.List<java.lang.String> getAllIssueTypeIds()
          Returns all issueType Ids.
 java.util.Collection<IssueType> getAllIssueTypeObjects()
          Returns a list of IssueTypes.
 java.util.List<org.ofbiz.core.entity.GenericValue> getAllIssueTypes()
          Deprecated. Use getAllIssueTypeObjects() instead. Deprecated since v4.0
 org.ofbiz.core.entity.GenericValue getConstant(java.lang.String constantType, java.lang.String id)
          Deprecated. Use getConstantObject(java.lang.String, java.lang.String) instead. Deprecated since v4.0
 org.ofbiz.core.entity.GenericValue getConstantByName(java.lang.String constantType, java.lang.String name)
          Returns a constant by name.
 IssueConstant getConstantByNameIgnoreCase(java.lang.String constantType, java.lang.String name)
          Returns a constant by name ignoring the case of the name passed in.
 IssueConstant getConstantObject(java.lang.String constantType, java.lang.String id)
          Returns an IssueConstant object for the given type & id.
 java.util.Collection getConstantObjects(java.lang.String constantType)
          Returns all IssueConstant objects for the given type.
 org.ofbiz.core.entity.GenericValue getDefaultPriority()
          Deprecated. Use getDefaultPriorityObject() instead. Since v4.0
 Priority getDefaultPriorityObject()
          Returns the default priority configured in JIRA.
 java.util.List<org.ofbiz.core.entity.GenericValue> getEditableSubTaskIssueTypes()
          Retrieves an editable list of sub-task issues.
 IssueConstant getIssueConstant(org.ofbiz.core.entity.GenericValue issueConstantGV)
          Converts a constant GenericValue to an IssueConstant object.
 org.ofbiz.core.entity.GenericValue getIssueType(java.lang.String id)
          Deprecated. Use getIssueTypeObject(String) instead
 IssueType getIssueTypeObject(java.lang.String id)
          Given an IssueType ID this method retrieves that IssueType.
 java.util.Collection<org.ofbiz.core.entity.GenericValue> getIssueTypes()
          Deprecated. Use getRegularIssueTypeObjects() instead.
 java.util.Collection<org.ofbiz.core.entity.GenericValue> getPriorities()
          Deprecated. Use getPriorityObjects() instead
 org.ofbiz.core.entity.GenericValue getPriority(java.lang.String id)
          Deprecated. Use getPriorityObject(String) instead.
 java.lang.String getPriorityName(java.lang.String id)
          Returns the priority Name for a given priority ID.
 Priority getPriorityObject(java.lang.String id)
          Given a priority ID, this method retrieves that priority.
 java.util.Collection<Priority> getPriorityObjects()
          Retrieve all Priorities in JIRA.
 java.util.Collection<IssueType> getRegularIssueTypeObjects()
          Retrieve regular (non-subtask) issue types.
 org.ofbiz.core.entity.GenericValue getResolution(java.lang.String id)
          Deprecated. Use getResolutionObject(String) instead.
 Resolution getResolutionObject(java.lang.String id)
          Given a resolution ID, this method retrieves that resolution.
 java.util.Collection<Resolution> getResolutionObjects()
          Retrieve all Resolutions in JIRA.
 java.util.Collection<org.ofbiz.core.entity.GenericValue> getResolutions()
          Deprecated. Use getResolutionObjects() instead.
 org.ofbiz.core.entity.GenericValue getStatus(java.lang.String id)
          Deprecated. Use getStatusObject(java.lang.String) instead. Deprecated since v4.0
 Status getStatusByName(java.lang.String name)
          Searches for a given status by name.
 java.util.Collection<org.ofbiz.core.entity.GenericValue> getStatuses()
          Deprecated. Use getStatusObjects() instead. Deprecated since v4.0
 Status getStatusObject(java.lang.String id)
          Returns a Status given an id.
 java.util.Collection<Status> getStatusObjects()
          Returns all statuses
 java.util.Collection<IssueType> getSubTaskIssueTypeObjects()
          Retrieves all the sub-task issue types
 java.util.Collection<org.ofbiz.core.entity.GenericValue> getSubTaskIssueTypes()
          Deprecated. Use getSubTaskIssueTypeObjects() instead. Deprecated since v4.0
 void refresh()
          Sets all cached copies of constant to null.
 void refreshIssueTypes()
          Reloads all IssueTypes from the DB.
 void refreshPriorities()
          Reloads all priorities from the DB.
 void refreshResolutions()
          Reloads all resolutions from the DB.
 void refreshStatuses()
          Reloads all statuses from DB.
 void removeIssueType(java.lang.String id)
          Removes an existing issueType.
 void storeIssueTypes(java.util.List<org.ofbiz.core.entity.GenericValue> issueTypes)
          Bulk operation to store a list of issueTypes.
 void updateIssueType(java.lang.String id, java.lang.String name, java.lang.Long sequence, java.lang.String style, java.lang.String description, java.lang.String iconurl)
          Updates an existing issueType.
 void validateCreateIssueType(java.lang.String name, java.lang.String style, java.lang.String description, java.lang.String iconurl, ErrorCollection errors, java.lang.String nameFieldName)
          Validates creation of a new issuetype.
 

Field Detail

ALL_STANDARD_ISSUE_TYPES

static final java.lang.String ALL_STANDARD_ISSUE_TYPES
Used to retrieve a standard IssueTypes.

See Also:
Constant Field Values

ALL_SUB_TASK_ISSUE_TYPES

static final java.lang.String ALL_SUB_TASK_ISSUE_TYPES
Used to retrieve a subtask IssueTypes.

See Also:
Constant Field Values

ALL_ISSUE_TYPES

static final java.lang.String ALL_ISSUE_TYPES
Used to retrieve all IssueTypes.

See Also:
Constant Field Values

PRIORITY_CONSTANT_TYPE

static final java.lang.String PRIORITY_CONSTANT_TYPE
Used in the generic getConstant(String, String) method

See Also:
Constant Field Values

STATUS_CONSTANT_TYPE

static final java.lang.String STATUS_CONSTANT_TYPE
Used in the generic getConstant(String, String) method

See Also:
Constant Field Values

RESOLUTION_CONSTANT_TYPE

static final java.lang.String RESOLUTION_CONSTANT_TYPE
Used in the generic getConstant(String, String) method

See Also:
Constant Field Values

ISSUE_TYPE_CONSTANT_TYPE

static final java.lang.String ISSUE_TYPE_CONSTANT_TYPE
Used in the generic getConstant(String, String) method

See Also:
Constant Field Values
Method Detail

getPriorities

@Deprecated
java.util.Collection<org.ofbiz.core.entity.GenericValue> getPriorities()
Deprecated. Use getPriorityObjects() instead

Retrieve all Priorities in JIRA.

Returns:
A list of Priority GenericValues.

getPriorityObjects

java.util.Collection<Priority> getPriorityObjects()
Retrieve all Priorities in JIRA.

Returns:
A list of Prioritys.

getPriority

@Deprecated
org.ofbiz.core.entity.GenericValue getPriority(java.lang.String id)
Deprecated. Use getPriorityObject(String) instead.

Given a priority ID, this method retrieves that priority.

Parameters:
id - The id of the priority
Returns:
A Priority GenericValue

getPriorityObject

Priority getPriorityObject(java.lang.String id)
Given a priority ID, this method retrieves that priority.

Parameters:
id - The id of the priority
Returns:
A Priority object.

getPriorityName

java.lang.String getPriorityName(java.lang.String id)
Returns the priority Name for a given priority ID.

Parameters:
id - The id of a priority
Returns:
The name of the priority with the given ID, or an i18n'd String indicating that no priority is set (e.g. "None") if the ID is null.

getDefaultPriority

org.ofbiz.core.entity.GenericValue getDefaultPriority()
Deprecated. Use getDefaultPriorityObject() instead. Since v4.0

Returns the default priority configured in JIRA.

Returns:
The default priority GenericValue.

getDefaultPriorityObject

Priority getDefaultPriorityObject()
Returns the default priority configured in JIRA.

Returns:
The default priority.

refreshPriorities

void refreshPriorities()
Reloads all priorities from the DB.


getResolutions

@Deprecated
java.util.Collection<org.ofbiz.core.entity.GenericValue> getResolutions()
Deprecated. Use getResolutionObjects() instead.

Retrieve all Resolutions in JIRA.

Returns:
A List of Resolution GenericValues.

getResolutionObjects

java.util.Collection<Resolution> getResolutionObjects()
Retrieve all Resolutions in JIRA.

Returns:
A List of Resolution objects.

getResolution

@Deprecated
org.ofbiz.core.entity.GenericValue getResolution(java.lang.String id)
Deprecated. Use getResolutionObject(String) instead.

Given a resolution ID, this method retrieves that resolution.

Parameters:
id - The id of the resolution
Returns:
A resolution GenericValue

getResolutionObject

Resolution getResolutionObject(java.lang.String id)
Given a resolution ID, this method retrieves that resolution.

Parameters:
id - The id of the resolution
Returns:
A Resolution object.

refreshResolutions

void refreshResolutions()
Reloads all resolutions from the DB.


getIssueType

@Deprecated
org.ofbiz.core.entity.GenericValue getIssueType(java.lang.String id)
Deprecated. Use getIssueTypeObject(String) instead

Given an IssueType ID this method retrieves that IssueType.

Parameters:
id - The ID of the IssueType.
Returns:
An IssueType GenericValue

getIssueTypeObject

IssueType getIssueTypeObject(java.lang.String id)
Given an IssueType ID this method retrieves that IssueType.

Parameters:
id - The ID of the IssueType.
Returns:
An IssueType object

getIssueTypes

@Deprecated
java.util.Collection<org.ofbiz.core.entity.GenericValue> getIssueTypes()
Deprecated. Use getRegularIssueTypeObjects() instead.

Retrieve regular (non-subtask) issue types.

Returns:
A collection of IssueType GenericValues

getRegularIssueTypeObjects

java.util.Collection<IssueType> getRegularIssueTypeObjects()
Retrieve regular (non-subtask) issue types.

Returns:
A collection of IssueTypes

getAllIssueTypeObjects

java.util.Collection<IssueType> getAllIssueTypeObjects()
Returns a list of IssueTypes.

Returns:
A Collection of IssueType objects.

getAllIssueTypes

@Deprecated
java.util.List<org.ofbiz.core.entity.GenericValue> getAllIssueTypes()
Deprecated. Use getAllIssueTypeObjects() instead. Deprecated since v4.0

Returns a list of IssueTypes.

Returns:
A list of GenericValue issueTypes.

getAllIssueTypeIds

java.util.List<java.lang.String> getAllIssueTypeIds()
Returns all issueType Ids.

Returns:
A list of all the IssueType Ids.

getSubTaskIssueTypes

@Deprecated
java.util.Collection<org.ofbiz.core.entity.GenericValue> getSubTaskIssueTypes()
Deprecated. Use getSubTaskIssueTypeObjects() instead. Deprecated since v4.0

Retrieves all the sub-task issue types. These will be non-modifiable. Use getEditableSubTaskIssueTypes() instead if you require an editable list.

Returns:
A Collection of sub-task GenericValues.

getSubTaskIssueTypeObjects

java.util.Collection<IssueType> getSubTaskIssueTypeObjects()
Retrieves all the sub-task issue types

Returns:
A Collection of all sub-task IssueTypes.

getEditableSubTaskIssueTypes

java.util.List<org.ofbiz.core.entity.GenericValue> getEditableSubTaskIssueTypes()
Retrieves an editable list of sub-task issues.

Returns:
A List of editable sub-task GenericValues

expandIssueTypeIds

java.util.List<java.lang.String> expandIssueTypeIds(java.util.Collection<java.lang.String> issueTypeIds)
Converts the 'special' ids of issue types to a list of issue type ids For example, converts a special id to a list of all sub-task issue types Also see ALL_STANDARD_ISSUE_TYPES, ALL_SUB_TASK_ISSUE_TYPES and ALL_ISSUE_TYPES.

Parameters:
issueTypeIds - A collection of the issuetype Ids to retrieve.
Returns:
A list of "actual" IssueType ID's expanded from the macro constants (or a new copy of the original list if it doesn't contain macros).

refreshIssueTypes

void refreshIssueTypes()
Reloads all IssueTypes from the DB.


createIssueType

org.ofbiz.core.entity.GenericValue createIssueType(java.lang.String name,
                                                   java.lang.Long sequence,
                                                   java.lang.String style,
                                                   java.lang.String description,
                                                   java.lang.String iconurl)
                                                   throws CreateException
Note this metod does not validate the input - i.e. It does not check for duplicate names etc. Use this method in conjunction with validateCreateIssueType(String, String, String, String, com.atlassian.jira.util.ErrorCollection, String)

Parameters:
name - Name of the new IssueType
sequence - Sequence number used for ordering the issuetypes in the UI.
style - Used to record the type of issue, such as SUBTASK. Null for regular issues.
description - A short description of the new issue type.
iconurl - A URL to an icon to be used for the new issueType.
Returns:
The newly created IssueType
Throws:
CreateException - If there is an error creating this Issue Type.

validateCreateIssueType

void validateCreateIssueType(java.lang.String name,
                             java.lang.String style,
                             java.lang.String description,
                             java.lang.String iconurl,
                             ErrorCollection errors,
                             java.lang.String nameFieldName)
Validates creation of a new issuetype. In particular, this function checks that a name has been submitted, no other issueTypes with the same name exist, and that the icon URL exists.

Parameters:
name - Name of the new IssueType
style - Used to record the type of issue, such as SUBTASK. Null for regular issues.
description - A short description of the new issue type.
iconurl - A URL to an icon to be used for the new issueType.
errors - A collection of errors used to pass back any problems.
nameFieldName - The field to which the errors should be added.

updateIssueType

void updateIssueType(java.lang.String id,
                     java.lang.String name,
                     java.lang.Long sequence,
                     java.lang.String style,
                     java.lang.String description,
                     java.lang.String iconurl)
                     throws DataAccessException
Updates an existing issueType. This will cause a refresh of all issue types (i.e. reload from the DB).

Parameters:
id - ID of the existing issuetype.
name - Name of the new IssueType
sequence - Sequence number used for ordering the issuetypes in the UI.
style - Used to record the type of issue, such as SUBTASK. Null for regular issues.
description - A short description of the new issue type.
iconurl - A URL to an icon to be used for the new issueType.
Throws:
DataAccessException - indicates an error in the Data Access Layer

removeIssueType

void removeIssueType(java.lang.String id)
                     throws RemoveException
Removes an existing issueType. This will cause a refresh of all issue types (i.e. reload from the DB).

Parameters:
id - ID of an existing issueType
Throws:
RemoveException - if the issueType with id doesn't exist, or an error occured removing the issue.

storeIssueTypes

void storeIssueTypes(java.util.List<org.ofbiz.core.entity.GenericValue> issueTypes)
                     throws DataAccessException
Bulk operation to store a list of issueTypes.

Parameters:
issueTypes - A list of IssueType GenericValues
Throws:
DataAccessException - indicates an error in the Data Access Layer

getStatus

@Deprecated
org.ofbiz.core.entity.GenericValue getStatus(java.lang.String id)
Deprecated. Use getStatusObject(java.lang.String) instead. Deprecated since v4.0

Returns a Status given an id.

Parameters:
id - The id of a status
Returns:
Returns a status GenericValue

getStatusObject

Status getStatusObject(java.lang.String id)
Returns a Status given an id.

Parameters:
id - The id of a status
Returns:
Returns a Status object.

getStatuses

@Deprecated
java.util.Collection<org.ofbiz.core.entity.GenericValue> getStatuses()
Deprecated. Use getStatusObjects() instead. Deprecated since v4.0

Returns all statuses

Returns:
Returns a Collection of status GenericValues.

getStatusObjects

java.util.Collection<Status> getStatusObjects()
Returns all statuses

Returns:
Returns a Collection of Status objects

refreshStatuses

void refreshStatuses()
Reloads all statuses from DB.


getStatusByName

Status getStatusByName(java.lang.String name)
Searches for a given status by name. This is not the most efficient implementation. If the name is not found, or the given name is null, then it returns null.

Parameters:
name - The name of the status.
Returns:
A Status object with the given name, or null if none found.

getConstant

@Deprecated
org.ofbiz.core.entity.GenericValue getConstant(java.lang.String constantType,
                                                          java.lang.String id)
Deprecated. Use getConstantObject(java.lang.String, java.lang.String) instead. Deprecated since v4.0

Generic method to retrieve a particular constant type.

Parameters:
constantType - See PRIORITY_CONSTANT_TYPE, STATUS_CONSTANT_TYPE, RESOLUTION_CONSTANT_TYPE, ISSUE_TYPE_CONSTANT_TYPE
id - The id of the constant.
Returns:
A GenericValue containing the constant. Null if it doesn't exist.

getConstantObject

IssueConstant getConstantObject(java.lang.String constantType,
                                java.lang.String id)
Returns an IssueConstant object for the given type & id.

Parameters:
constantType - See PRIORITY_CONSTANT_TYPE, STATUS_CONSTANT_TYPE, RESOLUTION_CONSTANT_TYPE, ISSUE_TYPE_CONSTANT_TYPE
id - The id of the constant.
Returns:
A IssueConstant object. Null if it doesn't exist.

getConstantObjects

java.util.Collection getConstantObjects(java.lang.String constantType)
Returns all IssueConstant objects for the given type.

Parameters:
constantType - See PRIORITY_CONSTANT_TYPE, STATUS_CONSTANT_TYPE, RESOLUTION_CONSTANT_TYPE, ISSUE_TYPE_CONSTANT_TYPE
Returns:
A collection of IssueConstant object.

convertToConstantObjects

java.util.List convertToConstantObjects(java.lang.String constantType,
                                        java.util.Collection ids)
Converts the list of ids to the objects of appropriate types

Parameters:
constantType - the constant type. Case insenstive
ids - list of constant ids or GenericValues
Returns:
List of IssueConstant subclasses. Null if constantType is null or the ids are empty

constantExists

boolean constantExists(java.lang.String constantType,
                       java.lang.String name)
Checks if a constant exists.

Parameters:
constantType - See PRIORITY_CONSTANT_TYPE, STATUS_CONSTANT_TYPE, RESOLUTION_CONSTANT_TYPE, ISSUE_TYPE_CONSTANT_TYPE
name - The name of the constant.
Returns:
True if the constant exists. False otherwise

getConstantByName

org.ofbiz.core.entity.GenericValue getConstantByName(java.lang.String constantType,
                                                     java.lang.String name)
Returns a constant by name.

Parameters:
constantType - See PRIORITY_CONSTANT_TYPE, STATUS_CONSTANT_TYPE, RESOLUTION_CONSTANT_TYPE, ISSUE_TYPE_CONSTANT_TYPE
name - The Name of the constant.
Returns:
A constant GenericValue TODO: Create alternative to GenericValue

getConstantByNameIgnoreCase

IssueConstant getConstantByNameIgnoreCase(java.lang.String constantType,
                                          java.lang.String name)
Returns a constant by name ignoring the case of the name passed in.

Parameters:
constantType - See PRIORITY_CONSTANT_TYPE, STATUS_CONSTANT_TYPE, RESOLUTION_CONSTANT_TYPE, ISSUE_TYPE_CONSTANT_TYPE
name - The Name of the constant, case-insensitive.
Returns:
An IssueConstant (or null if not found)

getIssueConstant

IssueConstant getIssueConstant(org.ofbiz.core.entity.GenericValue issueConstantGV)
Converts a constant GenericValue to an IssueConstant object.

Parameters:
issueConstantGV - the constant GenericValue.
Returns:
An IssueConstant object.

refresh

void refresh()
Sets all cached copies of constant to null. This will cause them to be re-loaded from the DB the next time they are accessed.



Copyright © 2002-2010 Atlassian. All Rights Reserved.