Package org.itracker.web.forms

Class IssueForm

java.lang.Object

org.apache.struts.action.ActionForm

org.apache.struts.validator.ValidatorForm

org.itracker.web.forms.ITrackerForm

org.itracker.web.forms.IssueForm

All Implemented Interfaces:

Serializable

public class IssueForm
extends ITrackerForm

This form is by the struts actions to pass issue data.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Fields inherited from class org.apache.struts.validator.ValidatorForm

page, validatorResults

Constructor Summary

Constructors

Constructor	Description
IssueForm()

Method Summary

Modifier and Type	Method	Description
org.itracker.model.Issue	addAttachment(org.itracker.model.Issue issue, org.itracker.model.Project project, org.itracker.model.User user, org.itracker.services.ITrackerServices services, org.apache.struts.action.ActionMessages messages)	Adds an attachment to issue.
void	applyLimitedFields(org.itracker.model.Issue issue, org.itracker.model.Project project, org.itracker.model.User user, Map<Integer,Set<org.itracker.model.PermissionType>> userPermissionsMap, Locale locale, org.itracker.services.IssueService issueService)
org.apache.struts.upload.FormFile	getAttachment()
String	getAttachmentDescription()
String	getCaller()
Integer[]	getComponents()
Integer	getCreatorId()
HashMap<String,String>	getCustomFields()
String	getDescription()
String	getHistory()
Integer	getId()
Integer	getOwnerId()
Integer	getPrevStatus()
Integer	getProjectId()
Integer	getRelatedIssueId()
org.itracker.model.IssueRelation.Type	getRelationType()
String	getResolution()
Integer	getSeverity()
Integer	getStatus()
Integer	getTargetVersion()
Integer[]	getVersions()
void	invokeProjectScripts(org.itracker.model.Project project, int event, Map<Integer,List<org.itracker.model.NameValuePair>> options, org.apache.struts.action.ActionMessages errors)
Map<Integer,List<org.itracker.model.NameValuePair>>	invokeProjectScripts(org.itracker.model.Project project, int event, org.apache.struts.action.ActionMessages errors)
static boolean	isWorkflowScriptsAllowed()
String	processFieldScript(org.itracker.model.ProjectScript projectScript, int event, String currentValue, List<org.itracker.model.NameValuePair> optionValues, org.apache.struts.action.ActionMessages currentErrors)	Run provided BEANSHELL script against form instance, taking into account incoming event type, field raised an event and current values.
void	processFieldScripts(List<org.itracker.model.ProjectScript> projectScriptModels, int event, Map<Integer,String> currentValues, Map<Integer,List<org.itracker.model.NameValuePair>> optionValues, org.apache.struts.action.ActionMessages currentErrors)	The most general way to run scripts.
org.itracker.model.Issue	processFullEdit(org.itracker.model.Issue issue, org.itracker.model.Project project, org.itracker.model.User user, Map<Integer,Set<org.itracker.model.PermissionType>> userPermissions, Locale locale, org.itracker.services.IssueService issueService, org.apache.struts.action.ActionMessages errors)
org.itracker.model.Issue	processLimitedEdit(org.itracker.model.Issue issue, org.itracker.model.Project project, org.itracker.model.User user, Map<Integer,Set<org.itracker.model.PermissionType>> userPermissionsMap, Locale locale, org.itracker.services.IssueService issueService, org.apache.struts.action.ActionMessages messages)
void	setAttachment(org.apache.struts.upload.FormFile attachment)
void	setAttachmentDescription(String attachmentDescription)
void	setCaller(String caller)
void	setComponents(Integer[] components)
void	setCreatorId(Integer creatorId)
void	setCustomFields(HashMap<String,String> customFields)
void	setDescription(String description)
void	setHistory(String history)
void	setId(Integer id)
void	setOwnerId(Integer ownerId)
void	setPrevStatus(Integer prevStatus)
void	setProjectId(Integer projectId)
void	setRelatedIssueId(Integer relatedIssueId)
void	setRelationType(org.itracker.model.IssueRelation.Type relationType)
void	setResolution(String resolution)
void	setSeverity(Integer severity)
void	setStatus(Integer status)
void	setTargetVersion(Integer targetVersion)
void	setupIssueForm(org.itracker.model.Issue issue, Map<Integer,List<org.itracker.model.NameValuePair>> listOptions, javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionMessages errors)
static void	setupJspEnv(org.apache.struts.action.ActionMapping mapping, IssueForm issueForm, javax.servlet.http.HttpServletRequest request, org.itracker.model.Issue issue, org.itracker.services.IssueService issueService, org.itracker.services.UserService userService, Map<Integer,Set<org.itracker.model.PermissionType>> userPermissions, Map<Integer,List<org.itracker.model.NameValuePair>> listOptions, org.apache.struts.action.ActionMessages errors)	method needed to prepare request for edit_issue.jsp
static void	setupNotificationsInRequest(javax.servlet.http.HttpServletRequest request, org.itracker.model.Issue issue, org.itracker.services.NotificationService notificationService)
static void	setupProjectFieldsMapJspEnv(List<org.itracker.model.CustomField> projectFields, Collection<org.itracker.model.IssueField> issueFields, javax.servlet.http.HttpServletRequest request)	Get project fields and put name and value in map TODO: simplify this code, it's not readable, unsave yet.
protected static void	setupRelationsRequestEnv(List<org.itracker.model.IssueRelation> relations, javax.servlet.http.HttpServletRequest request)
void	setVersions(Integer[] versions)
org.apache.struts.action.ActionErrors	validate(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)	This methods adds in validation for custom fields.

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate

Methods inherited from class org.itracker.web.forms.ITrackerForm

getITrackerServices

Methods inherited from class java.lang.Object

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

Methods inherited from class org.apache.struts.validator.ValidatorForm

getPage, getResultValueMap, getValidationKey, getValidatorResults, reset, setPage, setValidatorResults

Constructor Detail

IssueForm

public IssueForm()

Method Detail

processFieldScripts

public void processFieldScripts(List<org.itracker.model.ProjectScript> projectScriptModels,
                                int event,
                                Map<Integer,String> currentValues,
                                Map<Integer,List<org.itracker.model.NameValuePair>> optionValues,
                                org.apache.struts.action.ActionMessages currentErrors)
                         throws org.itracker.WorkflowException

The most general way to run scripts. All matching of event and fields are embedded within. As a result, optionValues parameter will contain updated values and form will contain new default values if appropriate.

Parameters:

projectScriptModels - is a list of scripts.

event - is an event type.

currentValues - values mapped to field-ids

optionValues - is a map of current values to fields by field-Id.

currentErrors - is a container for errors.

Throws:

org.itracker.WorkflowException

processFieldScript

public String processFieldScript(org.itracker.model.ProjectScript projectScript,
                                 int event,
                                 String currentValue,
                                 List<org.itracker.model.NameValuePair> optionValues,
                                 org.apache.struts.action.ActionMessages currentErrors)
                          throws org.itracker.WorkflowException

Run provided BEANSHELL script against form instance, taking into account incoming event type, field raised an event and current values. As a result, a set of new current values is returned and if appropriate, default values are changed in form. TODO: should issue, project, user, services be available too?

Parameters:

projectScript - is a script to run.

event - is an event type.

currentValue - the current field value

optionValues - is a set of valid option-values.

currentErrors - is a container for occured errors.

Returns:

new changed currentValue.

Throws:

org.itracker.WorkflowException

processFullEdit

public final org.itracker.model.Issue processFullEdit(org.itracker.model.Issue issue,
                                                      org.itracker.model.Project project,
                                                      org.itracker.model.User user,
                                                      Map<Integer,Set<org.itracker.model.PermissionType>> userPermissions,
                                                      Locale locale,
                                                      org.itracker.services.IssueService issueService,
                                                      org.apache.struts.action.ActionMessages errors)
                                               throws Exception

Throws:

Exception

applyLimitedFields

public final void applyLimitedFields(org.itracker.model.Issue issue,
                                     org.itracker.model.Project project,
                                     org.itracker.model.User user,
                                     Map<Integer,Set<org.itracker.model.PermissionType>> userPermissionsMap,
                                     Locale locale,
                                     org.itracker.services.IssueService issueService)
                              throws Exception

Throws:

Exception

processLimitedEdit

public final org.itracker.model.Issue processLimitedEdit(org.itracker.model.Issue issue,
                                                         org.itracker.model.Project project,
                                                         org.itracker.model.User user,
                                                         Map<Integer,Set<org.itracker.model.PermissionType>> userPermissionsMap,
                                                         Locale locale,
                                                         org.itracker.services.IssueService issueService,
                                                         org.apache.struts.action.ActionMessages messages)
                                                  throws Exception

Throws:

Exception

setupJspEnv

public static void setupJspEnv(org.apache.struts.action.ActionMapping mapping,
                               IssueForm issueForm,
                               javax.servlet.http.HttpServletRequest request,
                               org.itracker.model.Issue issue,
                               org.itracker.services.IssueService issueService,
                               org.itracker.services.UserService userService,
                               Map<Integer,Set<org.itracker.model.PermissionType>> userPermissions,
                               Map<Integer,List<org.itracker.model.NameValuePair>> listOptions,
                               org.apache.struts.action.ActionMessages errors)
                        throws javax.servlet.ServletException,
                               IOException,
                               org.itracker.WorkflowException

method needed to prepare request for edit_issue.jsp

Throws:

javax.servlet.ServletException

IOException

org.itracker.WorkflowException

setupProjectFieldsMapJspEnv

public static final void setupProjectFieldsMapJspEnv(List<org.itracker.model.CustomField> projectFields,
                                                     Collection<org.itracker.model.IssueField> issueFields,
                                                     javax.servlet.http.HttpServletRequest request)

Get project fields and put name and value in map TODO: simplify this code, it's not readable, unsave yet.

setupRelationsRequestEnv

protected static void setupRelationsRequestEnv(List<org.itracker.model.IssueRelation> relations,
                                               javax.servlet.http.HttpServletRequest request)

setupNotificationsInRequest

public static void setupNotificationsInRequest(javax.servlet.http.HttpServletRequest request,
                                               org.itracker.model.Issue issue,
                                               org.itracker.services.NotificationService notificationService)

addAttachment

public org.itracker.model.Issue addAttachment(org.itracker.model.Issue issue,
                                              org.itracker.model.Project project,
                                              org.itracker.model.User user,
                                              org.itracker.services.ITrackerServices services,
                                              org.apache.struts.action.ActionMessages messages)

Adds an attachment to issue.

Returns:

updated issue

setupIssueForm

public final void setupIssueForm(org.itracker.model.Issue issue,
                                 Map<Integer,List<org.itracker.model.NameValuePair>> listOptions,
                                 javax.servlet.http.HttpServletRequest request,
                                 org.apache.struts.action.ActionMessages errors)
                          throws org.itracker.WorkflowException

Throws:

org.itracker.WorkflowException

invokeProjectScripts

public void invokeProjectScripts(org.itracker.model.Project project,
                                 int event,
                                 Map<Integer,List<org.itracker.model.NameValuePair>> options,
                                 org.apache.struts.action.ActionMessages errors)
                          throws org.itracker.WorkflowException

Throws:

org.itracker.WorkflowException

invokeProjectScripts

public Map<Integer,List<org.itracker.model.NameValuePair>> invokeProjectScripts(org.itracker.model.Project project,
                                                                                int event,
                                                                                org.apache.struts.action.ActionMessages errors)
                                                                         throws org.itracker.WorkflowException

Throws:

org.itracker.WorkflowException

getAttachment

public org.apache.struts.upload.FormFile getAttachment()

setAttachment

public void setAttachment(org.apache.struts.upload.FormFile attachment)

getAttachmentDescription

public String getAttachmentDescription()

setAttachmentDescription

public void setAttachmentDescription(String attachmentDescription)

getCaller

public String getCaller()

setCaller

public void setCaller(String caller)

getComponents

public Integer[] getComponents()

setComponents

public void setComponents(Integer[] components)

getCreatorId

public Integer getCreatorId()

setCreatorId

public void setCreatorId(Integer creatorId)

getCustomFields

public HashMap<String,String> getCustomFields()

setCustomFields

public void setCustomFields(HashMap<String,String> customFields)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getHistory

public String getHistory()

setHistory

public void setHistory(String history)

getId

public Integer getId()

setId

public void setId(Integer id)

getOwnerId

public Integer getOwnerId()

setOwnerId

public void setOwnerId(Integer ownerId)

getPrevStatus

public Integer getPrevStatus()

setPrevStatus

public void setPrevStatus(Integer prevStatus)

getProjectId

public Integer getProjectId()

setProjectId

public void setProjectId(Integer projectId)

getRelatedIssueId

public Integer getRelatedIssueId()

setRelatedIssueId

public void setRelatedIssueId(Integer relatedIssueId)

getRelationType

public org.itracker.model.IssueRelation.Type getRelationType()

setRelationType

public void setRelationType(org.itracker.model.IssueRelation.Type relationType)

getResolution

public String getResolution()

setResolution

public void setResolution(String resolution)

getSeverity

public Integer getSeverity()

setSeverity

public void setSeverity(Integer severity)

getStatus

public Integer getStatus()

setStatus

public void setStatus(Integer status)

getTargetVersion

public Integer getTargetVersion()

setTargetVersion

public void setTargetVersion(Integer targetVersion)

getVersions

public Integer[] getVersions()

setVersions

public void setVersions(Integer[] versions)

validate

public org.apache.struts.action.ActionErrors validate(org.apache.struts.action.ActionMapping mapping,
                                                      javax.servlet.http.HttpServletRequest request)

This methods adds in validation for custom fields. It makes sure the datatype matches and also that all required fields have been populated.

Overrides:

validate in class org.apache.struts.validator.ValidatorForm

Parameters:

mapping - the ActionMapping object

request - the current HttpServletRequest object

Returns:

an ActionErrors object containing any validation errors

isWorkflowScriptsAllowed

public static boolean isWorkflowScriptsAllowed()