Package org.itracker.model.util

Class IssueUtilities

java.lang.Object

org.itracker.model.util.IssueUtilities

public class IssueUtilities
extends Object

Contains utilities used when displaying and processing issues.

Field Summary

Fields

Modifier and Type	Field	Description
static int	FIELD_ATTACHMENTDESCRIPTION
static int	FIELD_ATTACHMENTFILENAME
static int	FIELD_COMPONENTS
static int	FIELD_CREATEDATE
static int	FIELD_CREATOR
static int	FIELD_DESCRIPTION
static int	FIELD_HISTORY
static int	FIELD_ID
static int	FIELD_LASTMODIFIED
static int	FIELD_OWNER
static int	FIELD_PROJECT
static int	FIELD_RESOLUTION
static int	FIELD_SEVERITY
static int	FIELD_STATUS
static int	FIELD_TARGET_VERSION
static int	FIELD_TYPE_INDEXED
static int	FIELD_TYPE_MAP
static int	FIELD_TYPE_SINGLE
static int	FIELD_VERSIONS
static int	HISTORY_STATUS_AVAILABLE
static int	HISTORY_STATUS_REMOVED
static int	NUM_RELATION_TYPES
static int	RELATION_TYPE_CLONED_C	Defines a cloned issue.
static int	RELATION_TYPE_CLONED_P	Defines a cloned issue.
static int	RELATION_TYPE_DEPENDENT_C	Defines a dependent issue.
static int	RELATION_TYPE_DEPENDENT_P	Defines a dependent issue.
static int	RELATION_TYPE_DUPLICATE_C	Defines a duplicate issue.
static int	RELATION_TYPE_DUPLICATE_P	Defines a duplicate issue.
static int	RELATION_TYPE_RELATED_C	Defines a related issue.
static int	RELATION_TYPE_RELATED_P	Defines a related issue.
static int	RELATION_TYPE_SPLIT_C	Defines a split issue.
static int	RELATION_TYPE_SPLIT_P	Defines a split issue.
protected static int[]	STANDARD_FIELDS
static int	STATUS_ASSIGNED
static int	STATUS_CLOSED
static int	STATUS_END
static int	STATUS_NEW
static int	STATUS_RESOLVED
static int	STATUS_UNASSIGNED

Constructor Summary

Constructors

Constructor	Description
IssueUtilities()

Method Summary

Modifier and Type	Method	Description
static boolean	canBeAssignedIssue(Issue issue, Integer userId, Map<Integer,Set<PermissionType>> permissions)	Deprecated.
static boolean	canEditIssue(Issue issue, Integer userId, Map<Integer,Set<PermissionType>> permissions)	Deprecated.
static boolean	canUnassignIssue(Issue issue, Integer userId, Map<Integer,Set<PermissionType>> permissions)	Returns true if the user can unassign themselves from the issue.
static boolean	canViewIssue(Issue issue, Integer userId, Map<Integer,Set<PermissionType>> permissions)	Returns true if the user has permission to view the requested issue.
static boolean	canViewIssue(Issue issue, User user, Map<Integer,Set<PermissionType>> permissions)	Returns true if the user has permission to view the requested issue.
static String	checkResolutionName(String value, Locale locale)
static int	compareSeverity(Issue issueA, Issue issueB)	Compares the severity of two issues.
static String	componentsToString(Issue issue)
static String	getActivityName(IssueActivityType type)
static String	getActivityName(IssueActivityType type, Locale locale)
static CustomField	getCustomField(Integer id)	Returns the custom field with the supplied id.
static CustomField	getCustomField(Integer id, Locale locale)	Returns the custom field with the supplied id value.
static List<CustomField>	getCustomFields()	Returns the cached array of CustomFieldModels.
static String	getFieldName(Integer fieldId)
static String	getFieldName(Integer fieldId, List<CustomField> customFields, Locale locale)
static int	getFieldType(Integer fieldId)
static URL	getIssueURL(Issue issue, String baseURL)
static URL	getIssueURL(Issue issue, URL base)
static IssueRelation.Type	getMatchingRelationType(IssueRelation.Type relationType)
static int	getNumberCustomFields()	Returns the total number of defined custom fields
static int	getNumberSeverities()
static int	getNumberStatuses()
static String	getOwnerName(User owner, Locale locale)
static String	getRelationName(IssueRelation.Type value)
static String	getRelationName(IssueRelation.Type value, Locale locale)
static String	getResolutionName(int value)
static String	getResolutionName(int value, Locale locale)
static String	getResolutionName(String value, Locale locale)
static List<NameValuePair>	getResolutions(Locale locale)	Returns the list of predefined resolutions in the system.
static List<NameValuePair>	getSeverities(Locale locale)	Returns the list of the defined issue severities in the system.
static String	getSeverityName(Integer value)
static String	getSeverityName(Integer value, Locale locale)
static String	getSeverityName(String value, Locale locale)
static String	getStandardFieldKey(int fieldId)
static NameValuePair[]	getStandardFields(Locale locale)
static List<Configuration>	getStatuses()	getStatuses() needs to get implemented..
static List<NameValuePair>	getStatuses(Locale locale)
static String	getStatusName(Integer value)
static String	getStatusName(Integer value, Locale locale)
static String	getStatusName(String value, Locale locale)
static boolean	hasHardNotification(Issue issue, Project project, Integer userId)
static boolean	hasIssueNotification(Issue issue, Integer userId)
static boolean	hasIssueNotification(Issue issue, Project project, Integer userId)	Evaluate if a certain user is notified on issue change.
static boolean	hasIssueRelation(Issue issue, Integer relatedIssueId)
static String	historyToString(Issue issue, SimpleDateFormat sdf)
static void	setCustomFields(List<CustomField> value)	Sets the cached array of CustomFieldModels.
static void	setResolutions(List<Configuration> value)	Sets the cached list of predefined resolutions.
static void	setSeverities(List<Configuration> value)
static void	setStatuses(List<Configuration> value)
static String	versionsToString(Issue issue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FIELD_TYPE_SINGLE

public static final int FIELD_TYPE_SINGLE

See Also:

Constant Field Values

FIELD_TYPE_INDEXED

public static final int FIELD_TYPE_INDEXED

See Also:

Constant Field Values

FIELD_TYPE_MAP

public static final int FIELD_TYPE_MAP

See Also:

Constant Field Values

FIELD_ID

public static final int FIELD_ID

See Also:

Constant Field Values

FIELD_DESCRIPTION

public static final int FIELD_DESCRIPTION

See Also:

Constant Field Values

FIELD_STATUS

public static final int FIELD_STATUS

See Also:

Constant Field Values

FIELD_RESOLUTION

public static final int FIELD_RESOLUTION

See Also:

Constant Field Values

FIELD_SEVERITY

public static final int FIELD_SEVERITY

See Also:

Constant Field Values

FIELD_CREATOR

public static final int FIELD_CREATOR

See Also:

Constant Field Values

FIELD_CREATEDATE

public static final int FIELD_CREATEDATE

See Also:

Constant Field Values

FIELD_OWNER

public static final int FIELD_OWNER

See Also:

Constant Field Values

FIELD_LASTMODIFIED

public static final int FIELD_LASTMODIFIED

See Also:

Constant Field Values

FIELD_PROJECT

public static final int FIELD_PROJECT

See Also:

Constant Field Values

FIELD_TARGET_VERSION

public static final int FIELD_TARGET_VERSION

See Also:

Constant Field Values

FIELD_COMPONENTS

public static final int FIELD_COMPONENTS

See Also:

Constant Field Values

FIELD_VERSIONS

public static final int FIELD_VERSIONS

See Also:

Constant Field Values

FIELD_ATTACHMENTDESCRIPTION

public static final int FIELD_ATTACHMENTDESCRIPTION

See Also:

Constant Field Values

FIELD_ATTACHMENTFILENAME

public static final int FIELD_ATTACHMENTFILENAME

See Also:

Constant Field Values

FIELD_HISTORY

public static final int FIELD_HISTORY

See Also:

Constant Field Values

STANDARD_FIELDS

protected static final int[] STANDARD_FIELDS

STATUS_NEW

public static final int STATUS_NEW

See Also:

Constant Field Values

STATUS_UNASSIGNED

public static final int STATUS_UNASSIGNED

See Also:

Constant Field Values

STATUS_ASSIGNED

public static final int STATUS_ASSIGNED

See Also:

Constant Field Values

STATUS_RESOLVED

public static final int STATUS_RESOLVED

See Also:

Constant Field Values

STATUS_CLOSED

public static final int STATUS_CLOSED

See Also:

Constant Field Values

STATUS_END

public static final int STATUS_END

See Also:

Constant Field Values

HISTORY_STATUS_REMOVED

public static final int HISTORY_STATUS_REMOVED

See Also:

Constant Field Values

HISTORY_STATUS_AVAILABLE

public static final int HISTORY_STATUS_AVAILABLE

See Also:

Constant Field Values

RELATION_TYPE_RELATED_P

public static final int RELATION_TYPE_RELATED_P

Defines a related issue. Sample text: related to

See Also:

Constant Field Values

RELATION_TYPE_RELATED_C

public static final int RELATION_TYPE_RELATED_C

Defines a related issue. Sample text: related to

See Also:

Constant Field Values

RELATION_TYPE_DUPLICATE_P

public static final int RELATION_TYPE_DUPLICATE_P

Defines a duplicate issue. Sample text: duplicates

See Also:

Constant Field Values

RELATION_TYPE_DUPLICATE_C

public static final int RELATION_TYPE_DUPLICATE_C

Defines a duplicate issue. Sample text: duplicate of

See Also:

Constant Field Values

RELATION_TYPE_CLONED_P

public static final int RELATION_TYPE_CLONED_P

Defines a cloned issue. Sample text: cloned to

See Also:

Constant Field Values

RELATION_TYPE_CLONED_C

public static final int RELATION_TYPE_CLONED_C

Defines a cloned issue. Sample text: cloned from

See Also:

Constant Field Values

RELATION_TYPE_SPLIT_P

public static final int RELATION_TYPE_SPLIT_P

Defines a split issue. Sample text: split to

See Also:

Constant Field Values

RELATION_TYPE_SPLIT_C

public static final int RELATION_TYPE_SPLIT_C

Defines a split issue. Sample text: split from

See Also:

Constant Field Values

RELATION_TYPE_DEPENDENT_P

public static final int RELATION_TYPE_DEPENDENT_P

Defines a dependent issue. Sample text: dependents

See Also:

Constant Field Values

RELATION_TYPE_DEPENDENT_C

public static final int RELATION_TYPE_DEPENDENT_C

Defines a dependent issue. Sample text: depends on

See Also:

Constant Field Values

NUM_RELATION_TYPES

public static final int NUM_RELATION_TYPES

See Also:

Constant Field Values

Constructor Detail

IssueUtilities

public IssueUtilities()

Method Detail

getOwnerName

public static String getOwnerName(User owner,
                                  Locale locale)

getFieldType

public static int getFieldType(Integer fieldId)

getFieldName

public static String getFieldName(Integer fieldId)

getFieldName

public static String getFieldName(Integer fieldId,
                                  List<CustomField> customFields,
                                  Locale locale)

getStandardFieldKey

public static String getStandardFieldKey(int fieldId)

getStandardFields

public static NameValuePair[] getStandardFields(Locale locale)

getRelationName

public static String getRelationName(IssueRelation.Type value)

getRelationName

public static String getRelationName(IssueRelation.Type value,
                                     Locale locale)

getMatchingRelationType

public static IssueRelation.Type getMatchingRelationType(IssueRelation.Type relationType)

componentsToString

public static String componentsToString(Issue issue)

versionsToString

public static String versionsToString(Issue issue)

historyToString

public static String historyToString(Issue issue,
                                     SimpleDateFormat sdf)

getStatusName

public static String getStatusName(Integer value)

getStatusName

public static String getStatusName(Integer value,
                                   Locale locale)

getStatusName

public static String getStatusName(String value,
                                   Locale locale)

getStatuses

public static List<Configuration> getStatuses()

getStatuses() needs to get implemented..

getStatuses

public static List<NameValuePair> getStatuses(Locale locale)

setStatuses

public static void setStatuses(List<Configuration> value)

getNumberStatuses

public static int getNumberStatuses()

getSeverityName

public static String getSeverityName(Integer value)

getSeverityName

public static String getSeverityName(Integer value,
                                     Locale locale)

getSeverityName

public static String getSeverityName(String value,
                                     Locale locale)

getSeverities

public static List<NameValuePair> getSeverities(Locale locale)

Returns the list of the defined issue severities in the system. The array returned is a cached list set from the setSeverities method. The actual values are stored in the database and and can be obtained from the ConfigurationService bean.

Parameters:

locale - the locale to return the severities as

setSeverities

public static void setSeverities(List<Configuration> value)

getNumberSeverities

public static int getNumberSeverities()

compareSeverity

public static int compareSeverity(Issue issueA,
                                  Issue issueB)

Compares the severity of two issues. The int returned will be negative if the the severity of issue A is less than the severity of issue B, positive if issue A is a higher severity than issue B, or 0 if the two issues have the same severity.

Parameters:

issueA - IssueModel A

issueB - IssueModel B

getResolutionName

public static String getResolutionName(int value)

getResolutionName

public static String getResolutionName(int value,
                                       Locale locale)

getResolutionName

public static String getResolutionName(String value,
                                       Locale locale)

checkResolutionName

public static String checkResolutionName(String value,
                                         Locale locale)
                                  throws MissingResourceException

Throws:

MissingResourceException

getResolutions

public static List<NameValuePair> getResolutions(Locale locale)

Returns the list of predefined resolutions in the system. The array returned is a cached list set from the setResolutions method. The actual values are stored in the database and and can be obtained from the ConfigurationService bean.

Parameters:

locale - the locale to return the resolutions as

setResolutions

public static void setResolutions(List<Configuration> value)

Sets the cached list of predefined resolutions.

getActivityName

public static String getActivityName(IssueActivityType type)

getActivityName

public static String getActivityName(IssueActivityType type,
                                     Locale locale)

getCustomFields

public static List<CustomField> getCustomFields()

Returns the cached array of CustomFieldModels.

Returns:

an array of CustomFieldModels

setCustomFields

public static void setCustomFields(List<CustomField> value)

Sets the cached array of CustomFieldModels.

getCustomField

public static CustomField getCustomField(Integer id)

Returns the custom field with the supplied id. Any labels will be localized to the system default locale.

Parameters:

id - the id of the field to return

Returns:

the requested CustomField object, or a new field if not found

getCustomField

public static CustomField getCustomField(Integer id,
                                         Locale locale)

Returns the custom field with the supplied id value. Any labels will be translated to the given locale.

Parameters:

id - the id of the field to return

locale - the locale to initialize any labels with

Returns:

the requested CustomField object, or a new field if not found

getNumberCustomFields

public static int getNumberCustomFields()

Returns the total number of defined custom fields

canViewIssue

public static boolean canViewIssue(Issue issue,
                                   User user,
                                   Map<Integer,Set<PermissionType>> permissions)

Returns true if the user has permission to view the requested issue.

Parameters:

issue - an IssueModel of the issue to check view permission for

user - a User for the user to check permission for

permissions - a HashMap of the users permissions

canViewIssue

public static boolean canViewIssue(Issue issue,
                                   Integer userId,
                                   Map<Integer,Set<PermissionType>> permissions)

Returns true if the user has permission to view the requested issue.

Parameters:

issue - an IssueModel of the issue to check view permission for

userId - the userId of the user to check permission for

permissions - a HashMap of the users permissions

canEditIssue

@Deprecated
public static boolean canEditIssue(Issue issue,
                                   Integer userId,
                                   Map<Integer,Set<PermissionType>> permissions)

Deprecated.

Returns true if the user has permission to edit the requested issue.

Parameters:

issue - an IssueModel of the issue to check edit permission for

userId - the userId of the user to check permission for

permissions - a HashMap of the users permissions

canBeAssignedIssue

@Deprecated
public static boolean canBeAssignedIssue(Issue issue,
                                         Integer userId,
                                         Map<Integer,Set<PermissionType>> permissions)

Deprecated.

Returns true if the user can be assigned to this issue.

Parameters:

issue - an IssueModel of the issue to check assign permission for

userId - the userId of the user to check permission for

permissions - a HashMap of the users permissions

canUnassignIssue

public static boolean canUnassignIssue(Issue issue,
                                       Integer userId,
                                       Map<Integer,Set<PermissionType>> permissions)

Returns true if the user can unassign themselves from the issue.

Parameters:

issue - an IssueModel of the issue to check assign permission for

userId - the userId of the user to check permission for

permissions - a HashMap of the users permissions

hasIssueRelation

public static boolean hasIssueRelation(Issue issue,
                                       Integer relatedIssueId)

hasIssueNotification

public static boolean hasIssueNotification(Issue issue,
                                           Integer userId)

hasHardNotification

public static boolean hasHardNotification(Issue issue,
                                          Project project,
                                          Integer userId)

hasIssueNotification

public static boolean hasIssueNotification(Issue issue,
                                           Project project,
                                           Integer userId)

Evaluate if a certain user is notified on issue change.

FIXME: Does not work for admin of unassigned-issue-projects owner, see portalhome.do

getIssueURL

public static URL getIssueURL(Issue issue,
                              String baseURL)
                       throws MalformedURLException

Throws:

MalformedURLException

getIssueURL

public static URL getIssueURL(Issue issue,
                              URL base)