|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.issue.IssueInputParametersImpl
public class IssueInputParametersImpl
Default implementation of IssueInputParameters.
Plugin developers should callIssueService.newIssueInputParameters()
or IssueService.newIssueInputParameters(java.util.Map)
.
Constructor Summary | |
---|---|
IssueInputParametersImpl()
|
|
IssueInputParametersImpl(Map<String,String[]> actionParameters)
Can be used to quickly convert some "web-style" parameters (which can be the result of a form submit with the fields rendered create/edit html) to an IssueInputParameters object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IssueInputParametersImpl()
public IssueInputParametersImpl(Map<String,String[]> actionParameters)
actionParameters
- provides the default starting values for this object.Method Detail |
---|
public IssueInputParameters setProjectId(Long projectId)
setProjectId
in interface IssueInputParameters
projectId
- sets the project id for the issue.
public Long getProjectId()
getProjectId
in interface IssueInputParameters
public IssueInputParameters setIssueTypeId(String issueTypeId)
setIssueTypeId
in interface IssueInputParameters
issueTypeId
- sets the issue type for the issue.
public String getIssueTypeId()
getIssueTypeId
in interface IssueInputParameters
public IssueInputParameters setPriorityId(String priorityId)
setPriorityId
in interface IssueInputParameters
priorityId
- sets the priority for the issue.
public String getPriorityId()
getPriorityId
in interface IssueInputParameters
public IssueInputParameters setResolutionId(String resolutionId)
setResolutionId
in interface IssueInputParameters
resolutionId
- sets the resolution for the issue.
public String getResolutionId()
getResolutionId
in interface IssueInputParameters
public IssueInputParameters setStatusId(String statusId)
setStatusId
in interface IssueInputParameters
statusId
- sets the status of the issue.
public String getStatusId()
getStatusId
in interface IssueInputParameters
public IssueInputParameters setSummary(String summary)
setSummary
in interface IssueInputParameters
summary
- sets the summary for the issue.
public String getSummary()
getSummary
in interface IssueInputParameters
public IssueInputParameters setDescription(String description)
setDescription
in interface IssueInputParameters
description
- sets the description for the issue.
public String getDescription()
getDescription
in interface IssueInputParameters
public IssueInputParameters setEnvironment(String environment)
setEnvironment
in interface IssueInputParameters
environment
- sets the environment of the issue.
public String getEnvironment()
getEnvironment
in interface IssueInputParameters
public IssueInputParameters setAssigneeId(String assigneeId)
setAssigneeId
in interface IssueInputParameters
assigneeId
- sets the assignee id for the issue.
public String getAssigneeId()
getAssigneeId
in interface IssueInputParameters
public IssueInputParameters setReporterId(String reporterId)
setReporterId
in interface IssueInputParameters
reporterId
- sets the reporter id for the issue.
public String getReporterId()
getReporterId
in interface IssueInputParameters
public IssueInputParameters setComponentIds(Long... componentIds)
setComponentIds
in interface IssueInputParameters
componentIds
- sets the components id's on the issue.
public Long[] getComponentIds()
getComponentIds
in interface IssueInputParameters
public IssueInputParameters setFixVersionIds(Long... fixVersionIds)
setFixVersionIds
in interface IssueInputParameters
fixVersionIds
- sets the fix version id's on the issue.
public Long[] getFixVersionIds()
getFixVersionIds
in interface IssueInputParameters
public IssueInputParameters setAffectedVersionIds(Long... affectedVersionIds)
setAffectedVersionIds
in interface IssueInputParameters
affectedVersionIds
- sets the affected version id's= on the issue.
public Long[] getAffectedVersionIds()
getAffectedVersionIds
in interface IssueInputParameters
public IssueInputParameters setDueDate(String dueDate)
setDueDate
in interface IssueInputParameters
dueDate
- the formatted string that JIRA will accept as a date that will be set on the issue.
public String getDueDate()
getDueDate
in interface IssueInputParameters
public IssueInputParameters setResolutionDate(String resolutionDate)
setResolutionDate
in interface IssueInputParameters
resolutionDate
- the formatted string that JIRA will accept as a date that will be set on the issue.
public String getResolutionDate()
getResolutionDate
in interface IssueInputParameters
public IssueInputParameters setSecurityLevelId(Long securityLevelId)
setSecurityLevelId
in interface IssueInputParameters
securityLevelId
- sets the security level id on the issue.
public Long getSecurityLevelId()
getSecurityLevelId
in interface IssueInputParameters
public IssueInputParameters setOriginalEstimate(Long originalEstimate)
IssueInputParameters
APKeys.JIRA_OPTION_TIMETRACKING_ESTIMATES_LEGACY_BEHAVIOUR
is set,
we are in legacy time tracking mode and this method behaves differently.
See http://confluence.atlassian.com/display/JIRA044/Configuring+Time+Tracking#ConfiguringTimeTracking-legacymode
for more information on legacy mode.
IssueInputParameters.setOriginalAndRemainingEstimate(String, String)
/ IssueInputParameters.setOriginalAndRemainingEstimate(Long, Long)
.
Calls to IssueInputParameters.setOriginalEstimate(Long)
/ IssueInputParameters.setOriginalEstimate(String)
and IssueInputParameters.setRemainingEstimate(Long)
/
IssueInputParameters.setRemainingEstimate(String)
are mutually exclusive, so calling both on the same instance will
not produce the desired effect.
setOriginalEstimate
in interface IssueInputParameters
originalEstimate
- the new original estimate on the issue. The units used are determined by
APKeys.JIRA_TIMETRACKING_DEFAULT_UNIT
.
public IssueInputParameters setOriginalEstimate(String originalEstimate)
IssueInputParameters
APKeys.JIRA_OPTION_TIMETRACKING_ESTIMATES_LEGACY_BEHAVIOUR
is set,
we are in legacy time tracking mode and this method behaves differently.
See http://confluence.atlassian.com/display/JIRA044/Configuring+Time+Tracking#ConfiguringTimeTracking-legacymode
for more information on legacy mode.
IssueInputParameters.setOriginalAndRemainingEstimate(String, String)
. Calls to IssueInputParameters.setOriginalEstimate(Long)
/
IssueInputParameters.setOriginalEstimate(String)
and IssueInputParameters.setRemainingEstimate(Long)
/ IssueInputParameters.setRemainingEstimate(String)
are mutually exclusive, so calling both on the same instance will not produce the desired effect.
setOriginalEstimate
in interface IssueInputParameters
originalEstimate
- the new original estimate on the issue, e.g. "1d 5h" for 1 day and 5 hours
public IssueInputParameters setRemainingEstimate(Long remainingEstimate)
IssueInputParameters
APKeys.JIRA_OPTION_TIMETRACKING_ESTIMATES_LEGACY_BEHAVIOUR
is set,
we are in legacy time tracking mode and this method behaves differently.
See http://confluence.atlassian.com/display/JIRA044/Configuring+Time+Tracking#ConfiguringTimeTracking-legacymode
for more information on legacy mode.
IssueInputParameters.setOriginalEstimate(String)
, changing
the original and remaining estimate if work has not yet started.
If work has already been logged, it will alter the remaining estimate but leave the original
estimate unchanged.IssueInputParameters.setOriginalAndRemainingEstimate(String, String)
/ IssueInputParameters.setOriginalAndRemainingEstimate(Long, Long)
.
Calls to IssueInputParameters.setOriginalEstimate(Long)
/ IssueInputParameters.setOriginalEstimate(String)
and IssueInputParameters.setRemainingEstimate(Long)
/
IssueInputParameters.setRemainingEstimate(String)
are mutually exclusive, so calling both on the same instance will
not produce the desired effect.
setRemainingEstimate
in interface IssueInputParameters
remainingEstimate
- the remaining estimate on the issue. The units used are determined by
APKeys.JIRA_TIMETRACKING_DEFAULT_UNIT
.
public IssueInputParameters setRemainingEstimate(String remainingEstimate)
IssueInputParameters
APKeys.JIRA_OPTION_TIMETRACKING_ESTIMATES_LEGACY_BEHAVIOUR
is set,
we are in legacy time tracking mode and this method behaves differently.
See http://confluence.atlassian.com/display/JIRA044/Configuring+Time+Tracking#ConfiguringTimeTracking-legacymode
for more information on legacy mode.
IssueInputParameters.setOriginalEstimate(String)
, changing
the original and remaining estimate if work has not yet started.
If work has already been logged, it will alter the remaining estimate but leave the original
estimate unchanged.IssueInputParameters.setOriginalAndRemainingEstimate(String, String)
/ IssueInputParameters.setOriginalAndRemainingEstimate(Long, Long)
.
Calls to IssueInputParameters.setOriginalEstimate(Long)
/ IssueInputParameters.setOriginalEstimate(String)
and IssueInputParameters.setRemainingEstimate(Long)
/
IssueInputParameters.setRemainingEstimate(String)
are mutually exclusive, so calling both on the same instance will
not produce the desired effect.
setRemainingEstimate
in interface IssueInputParameters
remainingEstimate
- the remaining estimate on the issue, e.g. "1d 5h" for 1 day and 5 hours
public IssueInputParameters setOriginalAndRemainingEstimate(String originalEstimate, String remainingEstimate)
IssueInputParameters
APKeys.JIRA_OPTION_TIMETRACKING_ESTIMATES_LEGACY_BEHAVIOUR
is set,
we are in legacy time tracking mode and this method has no effect.
See http://confluence.atlassian.com/display/JIRA044/Configuring+Time+Tracking#ConfiguringTimeTracking-legacymode
for more information on legacy mode.
setOriginalAndRemainingEstimate
in interface IssueInputParameters
originalEstimate
- the new original estimate, e.g. "1d 5h" for 1 day and 5 hoursremainingEstimate
- the new remaining estimate, e.g. "1d 5h" for 1 day and 5 hours
public IssueInputParameters setOriginalAndRemainingEstimate(Long originalEstimate, Long remainingEstimate)
IssueInputParameters
APKeys.JIRA_OPTION_TIMETRACKING_ESTIMATES_LEGACY_BEHAVIOUR
is set,
we are in legacy time tracking mode and this method has no effect.
See http://confluence.atlassian.com/display/JIRA044/Configuring+Time+Tracking#ConfiguringTimeTracking-legacymode
for more information on legacy mode.
setOriginalAndRemainingEstimate
in interface IssueInputParameters
originalEstimate
- the new original estimate. The units used are determined by
APKeys.JIRA_TIMETRACKING_DEFAULT_UNIT
.remainingEstimate
- the new remaining estimate.The units used are determined by
APKeys.JIRA_TIMETRACKING_DEFAULT_UNIT
.
public Long getOriginalEstimate()
IssueInputParameters
APKeys.JIRA_OPTION_TIMETRACKING_ESTIMATES_LEGACY_BEHAVIOUR
is set,
we are in legacy time tracking mode and this will return the same as IssueInputParameters.getRemainingEstimate()
.
See http://confluence.atlassian.com/display/JIRA044/Configuring+Time+Tracking#ConfiguringTimeTracking-legacymode
for more information on legacy mode.
getOriginalEstimate
in interface IssueInputParameters
public Long getRemainingEstimate()
IssueInputParameters
APKeys.JIRA_OPTION_TIMETRACKING_ESTIMATES_LEGACY_BEHAVIOUR
is set,
we are in legacy time tracking mode and this will return the same as IssueInputParameters.getOriginalEstimate()
.
See http://confluence.atlassian.com/display/JIRA044/Configuring+Time+Tracking#ConfiguringTimeTracking-legacymode
for more information on legacy mode.
getRemainingEstimate
in interface IssueInputParameters
public String getRemainingEstimateAsDurationString()
IssueInputParameters
APKeys.JIRA_OPTION_TIMETRACKING_ESTIMATES_LEGACY_BEHAVIOUR
is set,
we are in legacy time tracking mode and this will return the same as IssueInputParameters.getOriginalEstimateAsDurationString()
.
See http://confluence.atlassian.com/display/JIRA044/Configuring+Time+Tracking#ConfiguringTimeTracking-legacymode
for more information on legacy mode.
getRemainingEstimateAsDurationString
in interface IssueInputParameters
public String getOriginalEstimateAsDurationString()
IssueInputParameters
APKeys.JIRA_OPTION_TIMETRACKING_ESTIMATES_LEGACY_BEHAVIOUR
is set,
we are in legacy time tracking mode and this will return the same as IssueInputParameters.getRemainingEstimateAsDurationString()
.
See http://confluence.atlassian.com/display/JIRA044/Configuring+Time+Tracking#ConfiguringTimeTracking-legacymode
for more information on legacy mode.
getOriginalEstimateAsDurationString
in interface IssueInputParameters
public IssueInputParameters setTimeSpent(Long timeSpent)
setTimeSpent
in interface IssueInputParameters
timeSpent
- sets the time spent on the issue.
public Long getTimeSpent()
getTimeSpent
in interface IssueInputParameters
public IssueInputParameters addCustomFieldValue(Long customFieldId, String... values)
IssueInputParameters
IssueInputParameters.addCustomFieldValue(String, String...)
.
addCustomFieldValue
in interface IssueInputParameters
customFieldId
- the unique identifier of the custom field.values
- the custom field values, must be in the format the field expects.
public IssueInputParameters addCustomFieldValue(String fullCustomFieldKey, String... values)
IssueInputParameters
addCustomFieldValue
in interface IssueInputParameters
fullCustomFieldKey
- used in the "web-style" parameters as the key, the custom field should expect this
value as the key in its populate from parameters method.values
- the custom field values, must be in the format the field expects.
public boolean retainExistingValuesWhenParameterNotProvided()
retainExistingValuesWhenParameterNotProvided
in interface IssueInputParameters
public void setRetainExistingValuesWhenParameterNotProvided(boolean retain)
setRetainExistingValuesWhenParameterNotProvided
in interface IssueInputParameters
retain
- true if non-provided parameters should have the values retained, false otherwise.IssueInputParameters.retainExistingValuesWhenParameterNotProvided()
public boolean applyDefaultValuesWhenParameterNotProvided()
applyDefaultValuesWhenParameterNotProvided
in interface IssueInputParameters
public void setApplyDefaultValuesWhenParameterNotProvided(boolean applyDefaultValuesWhenParameterNotProvided)
setApplyDefaultValuesWhenParameterNotProvided
in interface IssueInputParameters
applyDefaultValuesWhenParameterNotProvided
- true if default value should be supplied when a parameter has not been provided. false if the
default value should not be applied.public boolean skipScreenCheck()
IssueInputParameters
skipScreenCheck
in interface IssueInputParameters
IssueService.validateUpdate(com.atlassian.crowd.embedded.api.User, Long, IssueInputParameters)
public void setSkipScreenCheck(boolean skipScreenCheck)
IssueInputParameters
setSkipScreenCheck
in interface IssueInputParameters
skipScreenCheck
- whether or not we are skipping screen checkIssueService.validateUpdate(com.atlassian.crowd.embedded.api.User, Long, IssueInputParameters)
public String[] getCustomFieldValue(Long customFieldId)
getCustomFieldValue
in interface IssueInputParameters
customFieldId
- uniquely identifies the custom field value you are looking for.
public String[] getCustomFieldValue(String fullCustomFieldKey)
getCustomFieldValue
in interface IssueInputParameters
fullCustomFieldKey
- identifies the custom field values you are looking for.
public String getCommentValue()
getCommentValue
in interface IssueInputParameters
public IssueInputParameters setComment(String comment)
IssueInputParameters
setComment
in interface IssueInputParameters
comment
- the comment value.
public IssueInputParameters setComment(String comment, Long projectRoleId)
IssueInputParameters
setComment
in interface IssueInputParameters
comment
- the comment value.projectRoleId
- the id of the project role the comment must be restricted by.
public IssueInputParameters setComment(String comment, String groupId)
IssueInputParameters
setComment
in interface IssueInputParameters
comment
- the comment value.groupId
- the group name that the comment must be restricted by.
public Map<String,String[]> getActionParameters()
IssueInputParameters
getActionParameters
in interface IssueInputParameters
public void setFieldValuesHolder(Map<String,Object> fieldValuesHolder)
IssueInputParameters
setFieldValuesHolder
in interface IssueInputParameters
fieldValuesHolder
- provides the seed values for the field values holder.public Map<String,Object> getFieldValuesHolder()
getFieldValuesHolder
in interface IssueInputParameters
public Collection<String> getProvidedFields()
getProvidedFields
in interface IssueInputParameters
public void setProvidedFields(Collection<String> providedFields)
IssueInputParameters
setProvidedFields
in interface IssueInputParameters
providedFields
- a collection of Field.getId()
's which identify the
fields.public boolean isFieldSet(String fieldId)
isFieldSet
in interface IssueInputParameters
fieldId
- identifies the field in question, this will be the Field.getId()
.
public boolean isFieldPresent(String fieldId)
isFieldPresent
in interface IssueInputParameters
fieldId
- identifies the field in question, this will be the Field.getId()
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |