public class IssueInputParametersImpl extends Object implements IssueInputParameters
Plugin developers should call IssueService.newIssueInputParameters()
or IssueService.newIssueInputParameters(java.util.Map)
.
Constructor and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
IssueInputParameters |
addCustomFieldValue(Long customFieldId,
String... values)
Adds a value for a custom field with the specified id.
|
IssueInputParameters |
addCustomFieldValue(String fullCustomFieldKey,
String... values)
Adds a value for a custom field with the specified full key.
|
void |
addFieldToForcePresent(String fieldId)
Extra fields to consider present, even if they are not in the actionParams.
|
IssueInputParameters |
addProperty(String propertyKey,
org.codehaus.jackson.JsonNode propertyValue)
Allows properties to be set on issues during create or update
|
boolean |
applyDefaultValuesWhenParameterNotProvided() |
Map<String,String[]> |
getActionParameters()
This provides the "web-style" parameters that JIRA fields expect to perform their functions.
|
Long[] |
getAffectedVersionIds() |
String |
getAssigneeId() |
String |
getCommentValue() |
Long[] |
getComponentIds() |
String[] |
getCustomFieldValue(Long customFieldId) |
String[] |
getCustomFieldValue(String fullCustomFieldKey) |
String |
getDescription() |
String |
getDueDate() |
String |
getEnvironment() |
Map<String,Object> |
getFieldValuesHolder() |
Long[] |
getFixVersionIds() |
String |
getFormToken()
Return form token if it is present in input parameters
|
HistoryMetadata |
getHistoryMetadata() |
String |
getIssueTypeId() |
Long |
getOriginalEstimate()
Gets the original estimate set.
|
String |
getOriginalEstimateAsDurationString()
Gets the original estimate set.
|
String |
getPriorityId() |
Long |
getProjectId() |
Collection<String> |
getProvidedFields() |
Long |
getRemainingEstimate()
Gets the remaining estimate set.
|
String |
getRemainingEstimateAsDurationString()
Gets the remaining estimate provided
|
String |
getReporterId() |
String |
getResolutionDate() |
String |
getResolutionId() |
Long |
getSecurityLevelId() |
String |
getStatusId() |
String |
getSummary() |
Long |
getTimeSpent() |
boolean |
isFieldPresent(String fieldId) |
boolean |
isFieldSet(String fieldId) |
boolean |
onlyValidatePresentFieldsWhenRetainingExistingValues()
Get the flag to designate which fields are to be validated when the
IssueInputParameters.retainExistingValuesWhenParameterNotProvided()
flag is set to true . |
Map<String,org.codehaus.jackson.JsonNode> |
properties() |
boolean |
retainExistingValuesWhenParameterNotProvided() |
IssueInputParameters |
setAffectedVersionIds(Long... affectedVersionIds) |
void |
setApplyDefaultValuesWhenParameterNotProvided(boolean applyDefaultValuesWhenParameterNotProvided) |
IssueInputParameters |
setAssigneeId(String assigneeId) |
IssueInputParameters |
setComment(String comment)
Set a comment value with no visibility restrictions.
|
IssueInputParameters |
setComment(String comment,
Long projectRoleId)
Set a comment value with a project role restriction.
|
IssueInputParameters |
setComment(String comment,
String groupId)
Set a comment value with a group restriction.
|
IssueInputParameters |
setComponentIds(Long... componentIds) |
IssueInputParameters |
setDescription(String description) |
IssueInputParameters |
setDueDate(String dueDate) |
IssueInputParameters |
setEnvironment(String environment) |
void |
setFieldValuesHolder(Map<String,Object> fieldValuesHolder)
If set the validation will use the seed values from this field values holder.
|
IssueInputParameters |
setFixVersionIds(Long... fixVersionIds) |
IssueInputParameters |
setHistoryMetadata(HistoryMetadata historyMetadata)
Allows defining history metadata related to the issue update.
|
IssueInputParameters |
setIssueTypeId(String issueTypeId) |
IssueInputParameters |
setOriginalAndRemainingEstimate(Long originalEstimate,
Long remainingEstimate)
Sets both the original and remaining estimate on the issue.
|
IssueInputParameters |
setOriginalAndRemainingEstimate(String originalEstimate,
String remainingEstimate)
Sets both the original and remaining estimate on the issue.
|
IssueInputParameters |
setOriginalEstimate(Long originalEstimate)
Sets the original estimate on the issue.
|
IssueInputParameters |
setOriginalEstimate(String originalEstimate)
Sets the original estimate on the issue.
|
IssueInputParameters |
setPriorityId(String priorityId) |
IssueInputParameters |
setProjectId(Long projectId) |
void |
setProvidedFields(Collection<String> providedFields)
Use this to indicate which fields validation should be performed on, if left alone then the systems configured
fields for either create/update will be used.
|
IssueInputParameters |
setRemainingEstimate(Long remainingEstimate)
Sets the remaining estimate on the issue
|
IssueInputParameters |
setRemainingEstimate(String remainingEstimate)
Sets the remaining estimate on the issue
|
IssueInputParameters |
setReporterId(String reporterId) |
IssueInputParameters |
setResolutionDate(String resolutionDate) |
IssueInputParameters |
setResolutionId(String resolutionId) |
void |
setRetainExistingValuesWhenParameterNotProvided(boolean retain)
Flag to designate whether existing values should be retained when no parameter is provided.
|
void |
setRetainExistingValuesWhenParameterNotProvided(boolean retainExistingValues,
boolean onlyValidatePresentFields)
|
IssueInputParameters |
setSecurityLevelId(Long securityLevelId) |
void |
setSkipLicenceCheck(boolean skipLicenceCheck)
Set the flag to skip licence checks during create.
|
void |
setSkipScreenCheck(boolean skipScreenCheck)
Set the flag to skip screen checks during create, update or transition.
|
IssueInputParameters |
setStatusId(String statusId) |
IssueInputParameters |
setSummary(String summary) |
IssueInputParameters |
setTimeSpent(Long timeSpent) |
boolean |
skipLicenceCheck()
Returns
true if the skipLicenceCheck flag is set. |
boolean |
skipScreenCheck()
Get the flag to skip screen checks during create, update or transition.
|
public IssueInputParametersImpl()
public IssueInputParametersImpl(Map<String,String[]> actionParameters)
actionParameters
- provides the default starting values for this object.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
If (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
If (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 hourspublic IssueInputParameters setRemainingEstimate(Long remainingEstimate)
IssueInputParameters
If (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
If (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 hourspublic IssueInputParameters setOriginalAndRemainingEstimate(String originalEstimate, String remainingEstimate)
IssueInputParameters
If (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 hourspublic IssueInputParameters setOriginalAndRemainingEstimate(Long originalEstimate, Long remainingEstimate)
IssueInputParameters
If (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
If (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
If (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
If (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
If (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 setHistoryMetadata(HistoryMetadata historyMetadata)
IssueInputParameters
setHistoryMetadata
in interface IssueInputParameters
historyMetadata
- the metadata to save with the history changepublic HistoryMetadata getHistoryMetadata()
getHistoryMetadata
in interface IssueInputParameters
public String getFormToken()
IssueInputParameters
getFormToken
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)
IssueInputParameters
Note: setting this flag here will assume that validation of fields should still occur, even if they were not specified.
To change this, please use IssueInputParameters.setRetainExistingValuesWhenParameterNotProvided(boolean, boolean)
instead.
setRetainExistingValuesWhenParameterNotProvided
in interface IssueInputParameters
retain
- true if non-provided parameters should have the values retained, false otherwise.IssueInputParameters.retainExistingValuesWhenParameterNotProvided()
,
IssueInputParameters.setRetainExistingValuesWhenParameterNotProvided(boolean, boolean)
public void setRetainExistingValuesWhenParameterNotProvided(boolean retainExistingValues, boolean onlyValidatePresentFields)
IssueInputParameters
IssueInputParameters.retainExistingValuesWhenParameterNotProvided()
and IssueInputParameters.onlyValidatePresentFieldsWhenRetainingExistingValues()
.
The latter is only relevant when the former is true.
setRetainExistingValuesWhenParameterNotProvided
in interface IssueInputParameters
retainExistingValues
- true if non-provided parameters should have the values retained, false otherwise.onlyValidatePresentFields
- whether or not to only validate present fieldsIssueInputParameters.onlyValidatePresentFieldsWhenRetainingExistingValues()
,
IssueService.validateUpdate(ApplicationUser, Long, IssueInputParameters)
public boolean onlyValidatePresentFieldsWhenRetainingExistingValues()
IssueInputParameters
IssueInputParameters.retainExistingValuesWhenParameterNotProvided()
flag is set to true
.
If this flag is true
, only fields which are "present" will take part in validation (and subsequently
update) on the issue. This allows single-field edits to ignore the validation of other fields on the issue.
If this flag is false
, or if IssueInputParameters.retainExistingValuesWhenParameterNotProvided()
is false
,
then all fields on the screen of the current operation will partake in the "validation-update" step.
onlyValidatePresentFieldsWhenRetainingExistingValues
in interface IssueInputParameters
IssueService.validateUpdate(ApplicationUser, Long, IssueInputParameters)
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
By default, the Issue Service only allows setting values to fields which appear on the screen of the operation which you are performing (e.g. the Edit screen). By enabling this flag, the Issue Service will skip this check.
skipScreenCheck
in interface IssueInputParameters
IssueService.validateUpdate(ApplicationUser, Long, IssueInputParameters)
,
IssueService.validateCreate(ApplicationUser, IssueInputParameters)
public void setSkipScreenCheck(boolean skipScreenCheck)
IssueInputParameters
By default, the Issue Service only allows setting values to fields which appear on the screen of the operation which you are performing (e.g. the Edit screen). By enabling this flag, the Issue Service will skip this check.
setSkipScreenCheck
in interface IssueInputParameters
skipScreenCheck
- whether or not we are skipping screen checkIssueService.validateUpdate(ApplicationUser, Long, IssueInputParameters)
,
IssueService.validateCreate(ApplicationUser, IssueInputParameters)
public boolean skipLicenceCheck()
IssueInputParameters
true
if the skipLicenceCheck
flag is set.skipLicenceCheck
in interface IssueInputParameters
skipLicenceCheck
flag.public void setSkipLicenceCheck(boolean skipLicenceCheck)
IssueInputParameters
By default, the Issue Service will check the user is licensed to an application role. By enabling this flag, the Issue Service will skip this check.
setSkipLicenceCheck
in interface IssueInputParameters
skipLicenceCheck
- whether or not we are skipping the licence checkpublic 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 void addFieldToForcePresent(String fieldId)
IssueInputParameters
The action post params can also contain an array of fieldIds under the "fieldsToForcePresent" param.
This may be useful if you want to clear a field's value in a single field edit.
addFieldToForcePresent
in interface IssueInputParameters
fieldId
- the id of the field to force to be presentpublic boolean isFieldPresent(String fieldId)
isFieldPresent
in interface IssueInputParameters
fieldId
- identifies the field in question, this will be the Field.getId()
.public IssueInputParameters addProperty(String propertyKey, org.codehaus.jackson.JsonNode propertyValue)
IssueInputParameters
addProperty
in interface IssueInputParameters
propertyKey
- the key to the propertypropertyValue
- the JSON property valuepublic Map<String,org.codehaus.jackson.JsonNode> properties()
properties
in interface IssueInputParameters
Copyright © 2002-2021 Atlassian. All Rights Reserved.