|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.atlassian.jira.config.DefaultConstantsManager
public class DefaultConstantsManager
Field Summary |
---|
Fields inherited from interface com.atlassian.jira.config.ConstantsManager |
---|
ALL_ISSUE_TYPES, ALL_STANDARD_ISSUE_TYPES, ALL_SUB_TASK_ISSUE_TYPES, ISSUE_TYPE_CONSTANT_TYPE, PRIORITY_CONSTANT_TYPE, RESOLUTION_CONSTANT_TYPE, STATUS_CONSTANT_TYPE |
Constructor Summary | |
---|---|
DefaultConstantsManager(JiraAuthenticationContext authenticationContext,
TranslationManager translationManager,
OfBizDelegator ofBizDelegator,
com.atlassian.event.api.EventPublisher eventPublisher)
|
Method Summary | |
---|---|
boolean |
constantExists(String constantType,
String name)
Checks if a constant exists. |
List<IssueConstant> |
convertToConstantObjects(String constantType,
Collection ids)
Converts the list of ids to the objects of appropriate types |
org.ofbiz.core.entity.GenericValue |
createIssueType(String name,
Long sequence,
String style,
String description,
String iconurl)
Note this metod does not validate the input - i.e. |
List<String> |
expandIssueTypeIds(Collection<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 ConstantsManager.ALL_STANDARD_ISSUE_TYPES , ConstantsManager.ALL_SUB_TASK_ISSUE_TYPES and
ConstantsManager.ALL_ISSUE_TYPES . |
List<String> |
getAllIssueTypeIds()
Returns all issueType Ids. |
Collection<IssueType> |
getAllIssueTypeObjects()
Returns a list of IssueTypes. |
List<org.ofbiz.core.entity.GenericValue> |
getAllIssueTypes()
Returns a list of IssueTypes. |
org.ofbiz.core.entity.GenericValue |
getConstantByName(String constantType,
String name)
Returns a constant by name. |
IssueConstant |
getConstantByNameIgnoreCase(String constantType,
String name)
Returns a constant by name ignoring the case of the name passed in. |
IssueConstant |
getConstantObject(String constantType,
String id)
Returns an IssueConstant object for the given type & id. |
Collection |
getConstantObjects(String constantType)
Returns all IssueConstant objects for the given type. |
org.ofbiz.core.entity.GenericValue |
getDefaultPriority()
Returns the default priority configured in JIRA. |
Priority |
getDefaultPriorityObject()
Returns the default priority configured in JIRA. |
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. |
IssueConstant |
getIssueConstantByName(String constantType,
String name)
Returns a constant by name. |
org.ofbiz.core.entity.GenericValue |
getIssueType(String id)
Given an IssueType ID this method retrieves that IssueType. |
IssueType |
getIssueTypeObject(String id)
Given an IssueType ID this method retrieves that IssueType. |
Collection<org.ofbiz.core.entity.GenericValue> |
getIssueTypes()
Retrieve regular (non-subtask) issue types. |
Collection<org.ofbiz.core.entity.GenericValue> |
getPriorities()
Retrieve all Priorities in JIRA. |
String |
getPriorityName(String id)
Returns the priority Name for a given priority ID. |
Priority |
getPriorityObject(String id)
Given a priority ID, this method retrieves that priority. |
Collection<Priority> |
getPriorityObjects()
Retrieve all Priorities in JIRA. |
Collection<IssueType> |
getRegularIssueTypeObjects()
Retrieve regular (non-subtask) issue types. |
org.ofbiz.core.entity.GenericValue |
getResolution(String id)
Given a resolution ID, this method retrieves that resolution. |
Resolution |
getResolutionObject(String id)
Given a resolution ID, this method retrieves that resolution. |
Collection<Resolution> |
getResolutionObjects()
Retrieve all Resolutions in JIRA. |
Collection<org.ofbiz.core.entity.GenericValue> |
getResolutions()
Retrieve all Resolutions in JIRA. |
org.ofbiz.core.entity.GenericValue |
getStatus(String id)
Returns a Status given an id. |
Status |
getStatusByName(String name)
Searches for a given status by name. |
Status |
getStatusByTranslatedName(String name)
Searches for a given status by its translated name. |
Collection<org.ofbiz.core.entity.GenericValue> |
getStatuses()
Returns all statuses |
Status |
getStatusObject(String id)
Returns a Status given an id. |
Collection<Status> |
getStatusObjects()
Returns all statuses |
Collection<IssueType> |
getSubTaskIssueTypeObjects()
Retrieves all the sub-task issue types |
Collection<org.ofbiz.core.entity.GenericValue> |
getSubTaskIssueTypes()
Retrieve subtask issue types. |
IssueType |
insertIssueType(String name,
Long sequence,
String style,
String description,
String iconurl)
Creates a new IssueType. |
void |
onClearCache(ClearCacheEvent ignored)
|
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(String id)
Removes an existing issueType. |
void |
start()
This method wil be called after the plugin system is fully initialised and all components added to the dependency injection framework. |
void |
storeIssueTypes(List<org.ofbiz.core.entity.GenericValue> issueTypes)
Bulk operation to store a list of issueTypes. |
void |
updateIssueType(String id,
String name,
Long sequence,
String style,
String description,
String iconurl)
Updates an existing issueType. |
void |
validateCreateIssueType(String name,
String style,
String description,
String iconurl,
ErrorCollection errors,
String nameFieldName)
Validates creation of a new issuetype. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultConstantsManager(JiraAuthenticationContext authenticationContext, TranslationManager translationManager, OfBizDelegator ofBizDelegator, com.atlassian.event.api.EventPublisher eventPublisher)
Method Detail |
---|
public void start() throws Exception
Startable
start
in interface Startable
Exception
- Allows implementations to throw an Exception.@EventListener public void onClearCache(ClearCacheEvent ignored)
public Collection<org.ofbiz.core.entity.GenericValue> getStatuses()
ConstantsManager
getStatuses
in interface ConstantsManager
GenericValue
s.public Collection<Status> getStatusObjects()
ConstantsManager
getStatusObjects
in interface ConstantsManager
Status
objectspublic org.ofbiz.core.entity.GenericValue getStatus(String id)
ConstantsManager
getStatus
in interface ConstantsManager
id
- The id of a status
GenericValue
public Status getStatusObject(String id)
ConstantsManager
getStatusObject
in interface ConstantsManager
id
- The id of a status
Status
object.public void refreshStatuses()
ConstantsManager
refreshStatuses
in interface ConstantsManager
public IssueConstant getConstantObject(String constantType, String id)
ConstantsManager
IssueConstant
object for the given type & id.
getConstantObject
in interface ConstantsManager
constantType
- See ConstantsManager.PRIORITY_CONSTANT_TYPE
, ConstantsManager.STATUS_CONSTANT_TYPE
, ConstantsManager.RESOLUTION_CONSTANT_TYPE
, ConstantsManager.ISSUE_TYPE_CONSTANT_TYPE
id
- The id of the constant.
IssueConstant
object. Null if it doesn't exist.public Collection getConstantObjects(String constantType)
ConstantsManager
IssueConstant
objects for the given type.
getConstantObjects
in interface ConstantsManager
constantType
- See ConstantsManager.PRIORITY_CONSTANT_TYPE
, ConstantsManager.STATUS_CONSTANT_TYPE
, ConstantsManager.RESOLUTION_CONSTANT_TYPE
, ConstantsManager.ISSUE_TYPE_CONSTANT_TYPE
IssueConstant
object.public List<IssueConstant> convertToConstantObjects(String constantType, Collection ids)
ConstantsManager
convertToConstantObjects
in interface ConstantsManager
constantType
- the constant type. Case insenstiveids
- list of constant ids or GenericValues
public boolean constantExists(String constantType, String name)
ConstantsManager
constantExists
in interface ConstantsManager
constantType
- See ConstantsManager.PRIORITY_CONSTANT_TYPE
, ConstantsManager.STATUS_CONSTANT_TYPE
, ConstantsManager.RESOLUTION_CONSTANT_TYPE
, ConstantsManager.ISSUE_TYPE_CONSTANT_TYPE
name
- The name of the constant.
public IssueConstant getIssueConstantByName(String constantType, String name)
ConstantsManager
getIssueConstantByName
in interface ConstantsManager
constantType
- See ConstantsManager.PRIORITY_CONSTANT_TYPE
, ConstantsManager.STATUS_CONSTANT_TYPE
, ConstantsManager.RESOLUTION_CONSTANT_TYPE
, ConstantsManager.ISSUE_TYPE_CONSTANT_TYPE
name
- The Name of the constant.
public org.ofbiz.core.entity.GenericValue getConstantByName(String constantType, String name)
ConstantsManager
getConstantByName
in interface ConstantsManager
constantType
- See ConstantsManager.PRIORITY_CONSTANT_TYPE
, ConstantsManager.STATUS_CONSTANT_TYPE
, ConstantsManager.RESOLUTION_CONSTANT_TYPE
, ConstantsManager.ISSUE_TYPE_CONSTANT_TYPE
name
- The Name of the constant.
GenericValue
public IssueConstant getConstantByNameIgnoreCase(String constantType, String name)
ConstantsManager
getConstantByNameIgnoreCase
in interface ConstantsManager
constantType
- See ConstantsManager.PRIORITY_CONSTANT_TYPE
, ConstantsManager.STATUS_CONSTANT_TYPE
, ConstantsManager.RESOLUTION_CONSTANT_TYPE
, ConstantsManager.ISSUE_TYPE_CONSTANT_TYPE
name
- The Name of the constant, case-insensitive.
public org.ofbiz.core.entity.GenericValue createIssueType(String name, Long sequence, String style, String description, String iconurl) throws CreateException
ConstantsManager
ConstantsManager.validateCreateIssueType(String, String, String, String, com.atlassian.jira.util.ErrorCollection, String)
createIssueType
in interface ConstantsManager
name
- Name of the new IssueTypesequence
- 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.
CreateException
- If there is an error creating this Issue Type.public IssueType insertIssueType(String name, Long sequence, String style, String description, String iconurl) throws CreateException
ConstantsManager
Note this method does not validate the input - i.e. It does not check for duplicate names etc. Use
this method in conjunction with ConstantsManager.validateCreateIssueType(String, String, String, String, com.atlassian.jira.util.ErrorCollection, String)
insertIssueType
in interface ConstantsManager
name
- Name of the new IssueTypesequence
- 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.
CreateException
- If there is an error creating this Issue Type.public void validateCreateIssueType(String name, String style, String description, String iconurl, ErrorCollection errors, String nameFieldName)
ConstantsManager
validateCreateIssueType
in interface ConstantsManager
name
- Name of the new IssueTypestyle
- 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.public void updateIssueType(String id, String name, Long sequence, String style, String description, String iconurl) throws DataAccessException
ConstantsManager
updateIssueType
in interface ConstantsManager
id
- ID of the existing issuetype.name
- Name of the new IssueTypesequence
- 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.
DataAccessException
- indicates an error in the Data Access Layerpublic void removeIssueType(String id) throws RemoveException
ConstantsManager
removeIssueType
in interface ConstantsManager
id
- ID of an existing issueType
RemoveException
- if the issueType with id doesn't exist, or an error occured removing the issue.public void storeIssueTypes(List<org.ofbiz.core.entity.GenericValue> issueTypes) throws DataAccessException
ConstantsManager
storeIssueTypes
in interface ConstantsManager
issueTypes
- A list of IssueType GenericValue
s
DataAccessException
- indicates an error in the Data Access Layerpublic void refresh()
ConstantsManager
refresh
in interface ConstantsManager
public List<String> expandIssueTypeIds(Collection<String> issueTypeIds)
ConstantsManager
ConstantsManager.ALL_STANDARD_ISSUE_TYPES
, ConstantsManager.ALL_SUB_TASK_ISSUE_TYPES
and
ConstantsManager.ALL_ISSUE_TYPES
.
expandIssueTypeIds
in interface ConstantsManager
issueTypeIds
- A collection of the issuetype Ids to retrieve.
public List<String> getAllIssueTypeIds()
ConstantsManager
getAllIssueTypeIds
in interface ConstantsManager
public IssueConstant getIssueConstant(org.ofbiz.core.entity.GenericValue issueConstantGV)
ConstantsManager
GenericValue
to an IssueConstant
object.
getIssueConstant
in interface ConstantsManager
issueConstantGV
- the constant GenericValue
.
IssueConstant
object.public Collection<org.ofbiz.core.entity.GenericValue> getPriorities()
ConstantsManager
getPriorities
in interface ConstantsManager
GenericValue
s.public Collection<Priority> getPriorityObjects()
ConstantsManager
getPriorityObjects
in interface ConstantsManager
Priority
s.public Priority getPriorityObject(String id)
ConstantsManager
getPriorityObject
in interface ConstantsManager
id
- The id of the priority
Priority
object.public Priority getDefaultPriorityObject()
ConstantsManager
getDefaultPriorityObject
in interface ConstantsManager
public org.ofbiz.core.entity.GenericValue getDefaultPriority()
ConstantsManager
getDefaultPriority
in interface ConstantsManager
GenericValue
.public String getPriorityName(String id)
ConstantsManager
getPriorityName
in interface ConstantsManager
id
- the id of a priority
public Resolution getResolutionObject(String id)
ConstantsManager
getResolutionObject
in interface ConstantsManager
id
- The id of the resolution
Resolution
object.public void refreshPriorities()
ConstantsManager
refreshPriorities
in interface ConstantsManager
public Collection<org.ofbiz.core.entity.GenericValue> getResolutions()
ConstantsManager
getResolutions
in interface ConstantsManager
GenericValue
s.public Collection<Resolution> getResolutionObjects()
ConstantsManager
getResolutionObjects
in interface ConstantsManager
Resolution
objects.public org.ofbiz.core.entity.GenericValue getResolution(String id)
ConstantsManager
getResolution
in interface ConstantsManager
id
- The id of the resolution
GenericValue
public void refreshResolutions()
ConstantsManager
refreshResolutions
in interface ConstantsManager
public Collection<org.ofbiz.core.entity.GenericValue> getIssueTypes()
ConstantsManager
getIssueTypes
in interface ConstantsManager
GenericValue
spublic Collection<IssueType> getAllIssueTypeObjects()
ConstantsManager
getAllIssueTypeObjects
in interface ConstantsManager
IssueType
objects.public Collection<IssueType> getRegularIssueTypeObjects()
ConstantsManager
getRegularIssueTypeObjects
in interface ConstantsManager
IssueType
spublic Collection<IssueType> getSubTaskIssueTypeObjects()
ConstantsManager
getSubTaskIssueTypeObjects
in interface ConstantsManager
IssueType
s.public Status getStatusByName(String name)
ConstantsManager
getStatusByName
in interface ConstantsManager
name
- The name of the status.
Status
object with the given name, or null
if none found.public Status getStatusByTranslatedName(String name)
ConstantsManager
getStatusByTranslatedName
in interface ConstantsManager
name
- The name of the status.
Status
object with the given name, or null
if none found.public Collection<org.ofbiz.core.entity.GenericValue> getSubTaskIssueTypes()
getSubTaskIssueTypes
in interface ConstantsManager
GenericValue
spublic List<org.ofbiz.core.entity.GenericValue> getEditableSubTaskIssueTypes()
ConstantsManager
getEditableSubTaskIssueTypes
in interface ConstantsManager
GenericValue
spublic List<org.ofbiz.core.entity.GenericValue> getAllIssueTypes()
ConstantsManager
getAllIssueTypes
in interface ConstantsManager
GenericValue
issueTypes.public org.ofbiz.core.entity.GenericValue getIssueType(String id)
ConstantsManager
getIssueType
in interface ConstantsManager
id
- The ID of the IssueType.
GenericValue
public IssueType getIssueTypeObject(String id)
ConstantsManager
getIssueTypeObject
in interface ConstantsManager
id
- The ID of the IssueType.
IssueType
objectpublic void refreshIssueTypes()
ConstantsManager
refreshIssueTypes
in interface ConstantsManager
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |