java.lang.Object | |
↳ | com.atlassian.jira.issue.IssueInputParametersImpl |
Default implementation of IssueInputParameters.
Plugin developers should call newIssueInputParameters()
or newIssueInputParameters(java.util.Map)
.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
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.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Adds a value for a custom field with the specified full key.
| |||||||||||
Adds a value for a custom field with the specified id.
| |||||||||||
Extra fields to consider present, even if they are not in the actionParams.
| |||||||||||
This provides the "web-style" parameters that JIRA fields expect to perform their functions.
| |||||||||||
Return form token if it is present in input parameters
| |||||||||||
Gets the original estimate set.
| |||||||||||
Gets the original estimate set.
| |||||||||||
Gets the remaining estimate set.
| |||||||||||
Gets the remaining estimate provided
If ( | |||||||||||
Get the flag to designate which fields are to be validated when the
retainExistingValuesWhenParameterNotProvided()
flag is set to true . | |||||||||||
Set a comment value with a project role restriction.
| |||||||||||
Set a comment value with no visibility restrictions.
| |||||||||||
Set a comment value with a group restriction.
| |||||||||||
If set the validation will use the seed values from this field values holder.
| |||||||||||
Allows defining history metadata related to the issue update.
| |||||||||||
Sets both the original and remaining estimate on the issue.
| |||||||||||
Sets both the original and remaining estimate on the issue.
| |||||||||||
Sets the original estimate on the issue.
| |||||||||||
Sets the original estimate on the issue.
| |||||||||||
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.
| |||||||||||
Sets the remaining estimate on the issue
If ( | |||||||||||
Sets the remaining estimate on the issue
If ( | |||||||||||
Flag to designate whether existing values should be retained when no parameter is provided.
| |||||||||||
Set the flag to skip screen checks during create or update.
| |||||||||||
Get the flag to skip screen checks during create or update.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
com.atlassian.jira.issue.IssueInputParameters
|
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.
actionParameters | provides the default starting values for this object. |
---|
Adds a value for a custom field with the specified full key. This will put a value in the web-style parameters with a key as provided.
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. |
Adds a value for a custom field with the specified id. This will put a value in the web-style parameters with a key of the form "customfield_PROVIDED_ID". If you want to specify the key then use the method #addCustomFieldValue(String, String...).
customFieldId | the unique identifier of the custom field. |
---|---|
values | the custom field values, must be in the format the field expects. |
Extra fields to consider present, even if they are not in the actionParams. When "setRetainExisitingValuesWhenParameterNotProvided" is true, a field is not considered for update if its parameter is not provided. You can force a field to be considered even if its parameter is not providfed by forcing it to be considered by this setter.
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.
fieldId | the id of the field to force to be present |
---|
This provides the "web-style" parameters that JIRA fields expect to perform their functions.
Gets the original estimate set.
If (JIRA_OPTION_TIMETRACKING_ESTIMATES_LEGACY_BEHAVIOUR
is set,
we are in legacy time tracking mode and this will return the same as getRemainingEstimate()
.
See http://confluence.atlassian.com/display/JIRA044/Configuring+Time+Tracking#ConfiguringTimeTracking-legacymode for more information on legacy mode.
Gets the original estimate set.
If (JIRA_OPTION_TIMETRACKING_ESTIMATES_LEGACY_BEHAVIOUR
is set,
we are in legacy time tracking mode and this will return the same as getRemainingEstimateAsDurationString()
.
See http://confluence.atlassian.com/display/JIRA044/Configuring+Time+Tracking#ConfiguringTimeTracking-legacymode for more information on legacy mode.
Gets the remaining estimate set.
If (JIRA_OPTION_TIMETRACKING_ESTIMATES_LEGACY_BEHAVIOUR
is set,
we are in legacy time tracking mode and this will return the same as getOriginalEstimate()
.
See http://confluence.atlassian.com/display/JIRA044/Configuring+Time+Tracking#ConfiguringTimeTracking-legacymode for more information on legacy mode.
Gets the remaining estimate provided
If (JIRA_OPTION_TIMETRACKING_ESTIMATES_LEGACY_BEHAVIOUR
is set,
we are in legacy time tracking mode and this will return the same as getOriginalEstimateAsDurationString()
.
See http://confluence.atlassian.com/display/JIRA044/Configuring+Time+Tracking#ConfiguringTimeTracking-legacymode for more information on legacy mode.
Get the flag to designate which fields are to be validated when the 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 retainExistingValuesWhenParameterNotProvided()
is false
,
then all fields on the screen of the current operation will partake in the "validation-update" step.
Set a comment value with a project role restriction.
comment | the comment value. |
---|---|
projectRoleId | the id of the project role the comment must be restricted by. |
Set a comment value with no visibility restrictions.
comment | the comment value. |
---|
Set a comment value with a group restriction.
comment | the comment value. |
---|---|
groupId | the group name that the comment must be restricted by. |
If set the validation will use the seed values from this field values holder.
fieldValuesHolder | provides the seed values for the field values holder. |
---|
Allows defining history metadata related to the issue update. This is only relevant for changes that generate history entries (transitions and updates).
historyMetadata | the metadata to save with the history change |
---|
Sets both the original and remaining estimate on the issue.
If (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.
originalEstimate | the new original estimate, e.g. "1d 5h" for 1 day and 5 hours |
---|---|
remainingEstimate | the new remaining estimate, e.g. "1d 5h" for 1 day and 5 hours |
Sets both the original and remaining estimate on the issue.
If (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.
originalEstimate | the new original estimate. The units used are determined by
JIRA_TIMETRACKING_DEFAULT_UNIT . |
---|---|
remainingEstimate | the new remaining estimate.The units used are determined by
JIRA_TIMETRACKING_DEFAULT_UNIT . |
Sets the original estimate on the issue.
If (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.
setOriginalAndRemainingEstimate(String, String)
. Calls to setOriginalEstimate(Long)
/
setOriginalEstimate(String)
and setRemainingEstimate(Long)
/ setRemainingEstimate(String)
are mutually exclusive, so calling both on the same instance will not produce the desired effect.originalEstimate | the new original estimate on the issue, e.g. "1d 5h" for 1 day and 5 hours |
---|
Sets the original estimate on the issue.
If (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.
setOriginalAndRemainingEstimate(String, String)
/ setOriginalAndRemainingEstimate(Long, Long)
.
Calls to setOriginalEstimate(Long)
/ setOriginalEstimate(String)
and setRemainingEstimate(Long)
/
setRemainingEstimate(String)
are mutually exclusive, so calling both on the same instance will
not produce the desired effect.
originalEstimate | the new original estimate on the issue. The units used are determined by
JIRA_TIMETRACKING_DEFAULT_UNIT . |
---|
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.
providedFields | a collection of getId() 's which identify the
fields.
|
---|
Sets the remaining estimate on the issue
If (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.
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.setOriginalAndRemainingEstimate(String, String)
/ setOriginalAndRemainingEstimate(Long, Long)
.
Calls to setOriginalEstimate(Long)
/ setOriginalEstimate(String)
and setRemainingEstimate(Long)
/
setRemainingEstimate(String)
are mutually exclusive, so calling both on the same instance will
not produce the desired effect.
remainingEstimate | the remaining estimate on the issue, e.g. "1d 5h" for 1 day and 5 hours |
---|
Sets the remaining estimate on the issue
If (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.
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.setOriginalAndRemainingEstimate(String, String)
/ setOriginalAndRemainingEstimate(Long, Long)
.
Calls to setOriginalEstimate(Long)
/ setOriginalEstimate(String)
and setRemainingEstimate(Long)
/
setRemainingEstimate(String)
are mutually exclusive, so calling both on the same instance will
not produce the desired effect.
remainingEstimate | the remaining estimate on the issue. The units used are determined by
JIRA_TIMETRACKING_DEFAULT_UNIT . |
---|
Flag to designate whether existing values should be retained when no parameter is provided.
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 setRetainExistingValuesWhenParameterNotProvided(boolean, boolean)
instead.
retain | true if non-provided parameters should have the values retained, false otherwise. |
---|
Set flags retainExistingValuesWhenParameterNotProvided()
and onlyValidatePresentFieldsWhenRetainingExistingValues()
.
The latter is only relevant when the former is true.
retainExistingValues | true if non-provided parameters should have the values retained, false otherwise. |
---|---|
onlyValidatePresentFields | whether or not to only validate present fields |
Set the flag to skip screen checks during create or update.
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 | whether or not we are skipping screen check |
---|
Get the flag to skip screen checks during create or update.
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.