|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 String |
ALL_ISSUE_TYPES
Used to retrieve all IssueTypes. |
static String |
ALL_STANDARD_ISSUE_TYPES
Used to retrieve a standard IssueTypes. |
static String |
ALL_SUB_TASK_ISSUE_TYPES
Used to retrieve a subtask IssueTypes. |
static String |
ISSUE_TYPE_CONSTANT_TYPE
Used in the generic getConstant(String, String) method |
static String |
PRIORITY_CONSTANT_TYPE
Used in the generic getConstant(String, String) method |
static String |
RESOLUTION_CONSTANT_TYPE
Used in the generic getConstant(String, String) method |
static String |
STATUS_CONSTANT_TYPE
Used in the generic getConstant(String, String) method |
Method Summary | |
---|---|
boolean |
constantExists(String constantType,
String name)
Checks if a constant exists. |
List |
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 |
expandIssueTypeIds(Collection 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 . |
List |
getAllIssueTypeIds()
Returns all issueType Ids. |
Collection |
getAllIssueTypeObjects()
Returns a list of IssueTypes. |
List |
getAllIssueTypes()
Returns a list of IssueTypes. |
org.ofbiz.core.entity.GenericValue |
getConstant(String constantType,
String id)
Generic method to retrieve a particular constant type. |
org.ofbiz.core.entity.GenericValue |
getConstantByName(String constantType,
String name)
Returns a constant by name. |
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. |
List |
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(String id)
Deprecated. Use getIssueTypeObject(String) instead |
IssueType |
getIssueTypeObject(String id)
Given an issueType ID this method retrieves that issueType. |
Collection |
getIssueTypes()
Deprecated. Use getRegularIssueTypeObjects() instead. |
Collection |
getPriorities()
Deprecated. Use getPriorityObjects() instead |
org.ofbiz.core.entity.GenericValue |
getPriority(String id)
Deprecated. Use getPriorityObject(String) instead. |
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 |
getPriorityObjects()
Retrieve all Priorities in JIRA. |
Collection |
getRegularIssueTypeObjects()
Retrieve regular (non-subtask) issue types. |
org.ofbiz.core.entity.GenericValue |
getResolution(String id)
Deprecated. Use getResolutionObject(String) instead. |
Resolution |
getResolutionObject(String id)
Given a resolution ID, this method retrieves that resolution. |
Collection |
getResolutionObjects()
Retrieve all Resolutions in JIRA. |
Collection |
getResolutions()
Deprecated. Use getResolutionObjects() instead. |
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. |
Collection |
getStatuses()
Returns all statuses |
Status |
getStatusObject(String id)
Returns a Status given an id. |
Collection |
getStatusObjects()
Returns all statuses |
Collection |
getSubTaskIssueTypeObjects()
Retrieves all the sub-task issue types |
Collection |
getSubTaskIssueTypes()
Retrieves all the sub-task issue types. |
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 |
storeIssueTypes(List 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. |
Field Detail |
---|
static final String ALL_STANDARD_ISSUE_TYPES
static final String ALL_SUB_TASK_ISSUE_TYPES
static final String ALL_ISSUE_TYPES
static final String PRIORITY_CONSTANT_TYPE
getConstant(String, String)
method
static final String STATUS_CONSTANT_TYPE
getConstant(String, String)
method
static final String RESOLUTION_CONSTANT_TYPE
getConstant(String, String)
method
static final String ISSUE_TYPE_CONSTANT_TYPE
getConstant(String, String)
method
Method Detail |
---|
Collection getPriorities()
getPriorityObjects()
instead
GenericValue
s.Collection getPriorityObjects()
Priority
s.org.ofbiz.core.entity.GenericValue getPriority(String id)
getPriorityObject(String)
instead.
id
- The id of the priority
GenericValue
Priority getPriorityObject(String id)
id
- The id of the priority
Priority
object.String getPriorityName(String id)
id
- The id of a priority
org.ofbiz.core.entity.GenericValue getDefaultPriority()
GenericValue
.void refreshPriorities()
Collection getResolutions()
getResolutionObjects()
instead.
GenericValue
s.Collection getResolutionObjects()
Resolution
objects.org.ofbiz.core.entity.GenericValue getResolution(String id)
getResolutionObject(String)
instead.
id
- The id of the resolution
GenericValue
Resolution getResolutionObject(String id)
id
- The id of the resolution
Resolution
object.void refreshResolutions()
Collection getIssueTypes()
getRegularIssueTypeObjects()
instead.
GenericValue
sCollection getRegularIssueTypeObjects()
IssueType
sorg.ofbiz.core.entity.GenericValue getIssueType(String id)
getIssueTypeObject(String)
instead
id
- The ID of the IssueType.
GenericValue
IssueType getIssueTypeObject(String id)
id
- The ID of the IssueType.
IssueType
objectvoid refreshIssueTypes()
org.ofbiz.core.entity.GenericValue createIssueType(String name, Long sequence, String style, String description, String iconurl) throws CreateException
validateCreateIssueType(String, String, String, String, com.atlassian.jira.util.ErrorCollection, String)
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
void validateCreateIssueType(String name, String style, String description, String iconurl, ErrorCollection errors, String nameFieldName)
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.void updateIssueType(String id, String name, Long sequence, String style, String description, String iconurl) throws StoreException
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.
StoreException
void removeIssueType(String id) throws RemoveException
id
- ID of an existing issueType
RemoveException
- if the issueType with id doesn't exist, or an error occured removing the issue.void storeIssueTypes(List issueTypes) throws StoreException
issueTypes
- A list of IssueType GenericValue
s
StoreException
List getAllIssueTypes()
GenericValue
issueTypes.Collection getAllIssueTypeObjects()
IssueType
objects.List expandIssueTypeIds(Collection issueTypeIds)
ALL_STANDARD_ISSUE_TYPES
, ALL_SUB_TASK_ISSUE_TYPES
and
ALL_ISSUE_TYPES
.
issueTypeIds
- A collection of the issuetype Ids to retrieve.List getAllIssueTypeIds()
org.ofbiz.core.entity.GenericValue getStatus(String id)
id
- The id of a status
GenericValue
Status getStatusObject(String id)
id
- The id of a status
Status
object.Collection getStatuses()
GenericValue
s.Collection getStatusObjects()
Status
objectsvoid refreshStatuses()
Status getStatusByName(String name)
name
- The name of the status.
Status
object with the given name, or null
if none found.Collection getSubTaskIssueTypes()
getEditableSubTaskIssueTypes()
instead if you require an editable list.
GenericValue
s.Collection getSubTaskIssueTypeObjects()
IssueType
s.List getEditableSubTaskIssueTypes()
GenericValue
sorg.ofbiz.core.entity.GenericValue getConstant(String constantType, String id)
constantType
- See PRIORITY_CONSTANT_TYPE
, STATUS_CONSTANT_TYPE
, RESOLUTION_CONSTANT_TYPE
, ISSUE_TYPE_CONSTANT_TYPE
id
- The id of the constant.
GenericValue
containing the constant. Null if it doesn't exist.IssueConstant getConstantObject(String constantType, String id)
IssueConstant
object for the given type & id.
constantType
- See PRIORITY_CONSTANT_TYPE
, STATUS_CONSTANT_TYPE
, RESOLUTION_CONSTANT_TYPE
, ISSUE_TYPE_CONSTANT_TYPE
id
- The id of the constant.
IssueConstant
object. Null if it doesn't exist.Collection getConstantObjects(String constantType)
IssueConstant
objects for the given type.
constantType
- See PRIORITY_CONSTANT_TYPE
, STATUS_CONSTANT_TYPE
, RESOLUTION_CONSTANT_TYPE
, ISSUE_TYPE_CONSTANT_TYPE
IssueConstant
object.List convertToConstantObjects(String constantType, Collection ids)
constantType
- the constant type. Case insenstiveids
- list of constant ids or GenericValues
boolean constantExists(String constantType, String name)
constantType
- See PRIORITY_CONSTANT_TYPE
, STATUS_CONSTANT_TYPE
, RESOLUTION_CONSTANT_TYPE
, ISSUE_TYPE_CONSTANT_TYPE
name
- The name of the constant.
org.ofbiz.core.entity.GenericValue getConstantByName(String constantType, String name)
constantType
- See PRIORITY_CONSTANT_TYPE
, STATUS_CONSTANT_TYPE
, RESOLUTION_CONSTANT_TYPE
, ISSUE_TYPE_CONSTANT_TYPE
name
- The Name of the constant.
GenericValue
IssueConstant getIssueConstant(org.ofbiz.core.entity.GenericValue issueConstantGV)
GenericValue
to an IssueConstant
object.
issueConstantGV
- the constant GenericValue
.
IssueConstant
object.void refresh()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |