IssueInputParametersImpl (Atlassian Jira

java.lang.Object
- com.atlassian.jira.issue.IssueInputParametersImpl

All Implemented Interfaces:

IssueInputParameters
```
public class IssueInputParametersImpl
extends Object
implements IssueInputParameters
```
Default implementation of IssueInputParameters.
Plugin developers should call IssueService.newIssueInputParameters() or IssueService.newIssueInputParameters(java.util.Map).

Since:

v4.1

Constructor Summary

Constructors
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.

Method Summary

All Methods Instance Methods Concrete Methods
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)` Set flags `IssueInputParameters.retainExistingValuesWhenParameterNotProvided()` and `IssueInputParameters.onlyValidatePresentFieldsWhenRetainingExistingValues()`.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IssueInputParametersImpl
```
public IssueInputParametersImpl()
```
  - IssueInputParametersImpl
```
public 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.
    
    Parameters:
    
    actionParameters - provides the default starting values for this object.
- Method Detail
  - setProjectId
```
public IssueInputParameters setProjectId(Long projectId)
```
    Specified by:
    
    setProjectId in interface IssueInputParameters
    
    Parameters:
    
    projectId - sets the project id for the issue.
    
    Returns:
    
    this object.
  - getProjectId
```
public Long getProjectId()
```
    Specified by:
    
    getProjectId in interface IssueInputParameters
    
    Returns:
    
    the set project id, null if one does not exist or if it is not a valid number.
  - setIssueTypeId
```
public IssueInputParameters setIssueTypeId(String issueTypeId)
```
    Specified by:
    
    setIssueTypeId in interface IssueInputParameters
    
    Parameters:
    
    issueTypeId - sets the issue type for the issue.
    
    Returns:
    
    this object.
  - getIssueTypeId
```
public String getIssueTypeId()
```
    Specified by:
    
    getIssueTypeId in interface IssueInputParameters
    
    Returns:
    
    the set issue type id, null if one does not exist.
  - setPriorityId
```
public IssueInputParameters setPriorityId(String priorityId)
```
    Specified by:
    
    setPriorityId in interface IssueInputParameters
    
    Parameters:
    
    priorityId - sets the priority for the issue.
    
    Returns:
    
    this object.
  - getPriorityId
```
public String getPriorityId()
```
    Specified by:
    
    getPriorityId in interface IssueInputParameters
    
    Returns:
    
    the set priority id, null if one does not exist.
  - setResolutionId
```
public IssueInputParameters setResolutionId(String resolutionId)
```
    Specified by:
    
    setResolutionId in interface IssueInputParameters
    
    Parameters:
    
    resolutionId - sets the resolution for the issue.
    
    Returns:
    
    this object.
  - getResolutionId
```
public String getResolutionId()
```
    Specified by:
    
    getResolutionId in interface IssueInputParameters
    
    Returns:
    
    the set resolution id, null if one does not exist.
  - setStatusId
```
public IssueInputParameters setStatusId(String statusId)
```
    Specified by:
    
    setStatusId in interface IssueInputParameters
    
    Parameters:
    
    statusId - sets the status of the issue.
    
    Returns:
    
    this object.
  - getStatusId
```
public String getStatusId()
```
    Specified by:
    
    getStatusId in interface IssueInputParameters
    
    Returns:
    
    the set status id, null if one does not exist.
  - setSummary
```
public IssueInputParameters setSummary(String summary)
```
    Specified by:
    
    setSummary in interface IssueInputParameters
    
    Parameters:
    
    summary - sets the summary for the issue.
    
    Returns:
    
    this object.
  - getSummary
```
public String getSummary()
```
    Specified by:
    
    getSummary in interface IssueInputParameters
    
    Returns:
    
    the set summary, null if one does not exist.
  - setDescription
```
public IssueInputParameters setDescription(String description)
```
    Specified by:
    
    setDescription in interface IssueInputParameters
    
    Parameters:
    
    description - sets the description for the issue.
    
    Returns:
    
    this object.
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface IssueInputParameters
    
    Returns:
    
    the set description, null if one does not exist.
  - setEnvironment
```
public IssueInputParameters setEnvironment(String environment)
```
    Specified by:
    
    setEnvironment in interface IssueInputParameters
    
    Parameters:
    
    environment - sets the environment of the issue.
    
    Returns:
    
    this object.
  - getEnvironment
```
public String getEnvironment()
```
    Specified by:
    
    getEnvironment in interface IssueInputParameters
    
    Returns:
    
    the set environment, null if one does not exist.
  - setAssigneeId
```
public IssueInputParameters setAssigneeId(String assigneeId)
```
    Specified by:
    
    setAssigneeId in interface IssueInputParameters
    
    Parameters:
    
    assigneeId - sets the assignee id for the issue.
    
    Returns:
    
    this object.
  - getAssigneeId
```
public String getAssigneeId()
```
    Specified by:
    
    getAssigneeId in interface IssueInputParameters
    
    Returns:
    
    the set assginee, null if one does not exist.
  - setReporterId
```
public IssueInputParameters setReporterId(String reporterId)
```
    Specified by:
    
    setReporterId in interface IssueInputParameters
    
    Parameters:
    
    reporterId - sets the reporter id for the issue.
    
    Returns:
    
    this object.
  - getReporterId
```
public String getReporterId()
```
    Specified by:
    
    getReporterId in interface IssueInputParameters
    
    Returns:
    
    the set reporter, null if one does not exist.
  - setComponentIds
```
public IssueInputParameters setComponentIds(Long... componentIds)
```
    Specified by:
    
    setComponentIds in interface IssueInputParameters
    
    Parameters:
    
    componentIds - sets the components id's on the issue.
    
    Returns:
    
    this object.
  - getComponentIds
```
public Long[] getComponentIds()
```
    Specified by:
    
    getComponentIds in interface IssueInputParameters
    
    Returns:
    
    the set component id's, null if they do not exist or if they are not valid numbers.
  - setFixVersionIds
```
public IssueInputParameters setFixVersionIds(Long... fixVersionIds)
```
    Specified by:
    
    setFixVersionIds in interface IssueInputParameters
    
    Parameters:
    
    fixVersionIds - sets the fix version id's on the issue.
    
    Returns:
    
    this object.
  - getFixVersionIds
```
public Long[] getFixVersionIds()
```
    Specified by:
    
    getFixVersionIds in interface IssueInputParameters
    
    Returns:
    
    the set fix version id's, null if they do not exist or if they are not valid numbers.
  - setAffectedVersionIds
```
public IssueInputParameters setAffectedVersionIds(Long... affectedVersionIds)
```
    Specified by:
    
    setAffectedVersionIds in interface IssueInputParameters
    
    Parameters:
    
    affectedVersionIds - sets the affected version id's= on the issue.
    
    Returns:
    
    this object.
  - getAffectedVersionIds
```
public Long[] getAffectedVersionIds()
```
    Specified by:
    
    getAffectedVersionIds in interface IssueInputParameters
    
    Returns:
    
    the set affected version id's, null if they do not exist or if they are not valid numbers.
  - setDueDate
```
public IssueInputParameters setDueDate(String dueDate)
```
    Specified by:
    
    setDueDate in interface IssueInputParameters
    
    Parameters:
    
    dueDate - the formatted string that JIRA will accept as a date that will be set on the issue.
    
    Returns:
    
    this object.
  - getDueDate
```
public String getDueDate()
```
    Specified by:
    
    getDueDate in interface IssueInputParameters
    
    Returns:
    
    the set due date, null if one does not exist.
  - setResolutionDate
```
public IssueInputParameters setResolutionDate(String resolutionDate)
```
    Specified by:
    
    setResolutionDate in interface IssueInputParameters
    
    Parameters:
    
    resolutionDate - the formatted string that JIRA will accept as a date that will be set on the issue.
    
    Returns:
    
    this object.
  - getResolutionDate
```
public String getResolutionDate()
```
    Specified by:
    
    getResolutionDate in interface IssueInputParameters
    
    Returns:
    
    the set resolution date, null if one does not exist.
  - setSecurityLevelId
```
public IssueInputParameters setSecurityLevelId(Long securityLevelId)
```
    Specified by:
    
    setSecurityLevelId in interface IssueInputParameters
    
    Parameters:
    
    securityLevelId - sets the security level id on the issue.
    
    Returns:
    
    this object.
  - getSecurityLevelId
```
public Long getSecurityLevelId()
```
    Specified by:
    
    getSecurityLevelId in interface IssueInputParameters
    
    Returns:
    
    the set security level id, null if one does not exist or it is not a valid number.
  - setOriginalEstimate
```
public IssueInputParameters setOriginalEstimate(Long originalEstimate)
```
    Description copied from interface: IssueInputParameters
    Sets the original estimate on the issue.
    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.
    - In legacy mode, this will change 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
    - In modern mode, this will only change the original estimate. If you want to change both in a single request use 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.
    Specified by:
    
    setOriginalEstimate in interface IssueInputParameters
    
    Parameters:
    
    originalEstimate - the new original estimate on the issue. The units used are determined by APKeys.JIRA_TIMETRACKING_DEFAULT_UNIT.
    
    Returns:
    
    this object.
  - setOriginalEstimate
```
public IssueInputParameters setOriginalEstimate(String originalEstimate)
```
    Description copied from interface: IssueInputParameters
    Sets the original estimate on the issue.
    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.
    - In legacy mode, this will change 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
    - In modern mode, this will only change the original estimate. If you want to change both in a single request use 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.
    Specified by:
    
    setOriginalEstimate in interface IssueInputParameters
    
    Parameters:
    
    originalEstimate - the new original estimate on the issue, e.g. "1d 5h" for 1 day and 5 hours
    
    Returns:
    
    this object.
  - setRemainingEstimate
```
public IssueInputParameters setRemainingEstimate(Long remainingEstimate)
```
    Description copied from interface: IssueInputParameters
    Sets the remaining estimate on the issue
    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.
    - In legacy mode, this has the same behaviour as 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.
    - In modern mode, this will only change the remaining estimate. If you want to change both in a single request use 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.
    Specified by:
    
    setRemainingEstimate in interface IssueInputParameters
    
    Parameters:
    
    remainingEstimate - the remaining estimate on the issue. The units used are determined by APKeys.JIRA_TIMETRACKING_DEFAULT_UNIT.
    
    Returns:
    
    this object
  - setRemainingEstimate
```
public IssueInputParameters setRemainingEstimate(String remainingEstimate)
```
    Description copied from interface: IssueInputParameters
    Sets the remaining estimate on the issue
    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.
    - In legacy mode, this has the same behaviour as 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.
    - In modern mode, this will only change the remaining estimate. If you want to change both in a single request use 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.
    Specified by:
    
    setRemainingEstimate in interface IssueInputParameters
    
    Parameters:
    
    remainingEstimate - the remaining estimate on the issue, e.g. "1d 5h" for 1 day and 5 hours
    
    Returns:
    
    this object
  - setOriginalAndRemainingEstimate
```
public IssueInputParameters setOriginalAndRemainingEstimate(String originalEstimate,
                                                            String remainingEstimate)
```
    Description copied from interface: IssueInputParameters
    
    Sets both the original and remaining estimate on the issue.
    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.
    
    Specified by:
    
    setOriginalAndRemainingEstimate in interface IssueInputParameters
    
    Parameters:
    
    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
    
    Returns:
    
    this object
  - setOriginalAndRemainingEstimate
```
public IssueInputParameters setOriginalAndRemainingEstimate(Long originalEstimate,
                                                            Long remainingEstimate)
```
    Description copied from interface: IssueInputParameters
    
    Sets both the original and remaining estimate on the issue.
    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.
    
    Specified by:
    
    setOriginalAndRemainingEstimate in interface IssueInputParameters
    
    Parameters:
    
    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.
    
    Returns:
    
    this object
  - getOriginalEstimate
```
public Long getOriginalEstimate()
```
    Description copied from interface: IssueInputParameters
    
    Gets the original estimate set.
    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.
    
    Specified by:
    
    getOriginalEstimate in interface IssueInputParameters
    
    Returns:
    
    the set original estimate, null if one does not exist or it is not a valid number.
  - getRemainingEstimate
```
public Long getRemainingEstimate()
```
    Description copied from interface: IssueInputParameters
    
    Gets the remaining estimate set.
    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.
    
    Specified by:
    
    getRemainingEstimate in interface IssueInputParameters
    
    Returns:
    
    the set remaining estimate, null if one does not exist or it is not a valid number.
  - getRemainingEstimateAsDurationString
```
public String getRemainingEstimateAsDurationString()
```
    Description copied from interface: IssueInputParameters
    
    Gets the remaining estimate provided
    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.
    
    Specified by:
    
    getRemainingEstimateAsDurationString in interface IssueInputParameters
    
    Returns:
    
    the set remaining estimate, null if one does not exist.
  - getOriginalEstimateAsDurationString
```
public String getOriginalEstimateAsDurationString()
```
    Description copied from interface: IssueInputParameters
    
    Gets the original estimate set.
    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.
    
    Specified by:
    
    getOriginalEstimateAsDurationString in interface IssueInputParameters
    
    Returns:
    
    the set original estimate, null if one does not exist.
  - setTimeSpent
```
public IssueInputParameters setTimeSpent(Long timeSpent)
```
    Specified by:
    
    setTimeSpent in interface IssueInputParameters
    
    Parameters:
    
    timeSpent - sets the time spent on the issue.
    
    Returns:
    
    this object.
  - getTimeSpent
```
public Long getTimeSpent()
```
    Specified by:
    
    getTimeSpent in interface IssueInputParameters
    
    Returns:
    
    the set time spent, null if one does not exist or it is not a valid number.
  - setHistoryMetadata
```
public IssueInputParameters setHistoryMetadata(HistoryMetadata historyMetadata)
```
    Description copied from interface: IssueInputParameters
    
    Allows defining history metadata related to the issue update. This is only relevant for changes that generate history entries (transitions and updates).
    
    Specified by:
    
    setHistoryMetadata in interface IssueInputParameters
    
    Parameters:
    
    historyMetadata - the metadata to save with the history change
    
    Returns:
    
    this object
  - getHistoryMetadata
```
public HistoryMetadata getHistoryMetadata()
```
    Specified by:
    
    getHistoryMetadata in interface IssueInputParameters
    
    Returns:
    
    the current history metadata for the update, null if not defined
  - getFormToken
```
public String getFormToken()
```
    Description copied from interface: IssueInputParameters
    
    Return form token if it is present in input parameters
    
    Specified by:
    
    getFormToken in interface IssueInputParameters
    
    Returns:
    
    the form token
  - addCustomFieldValue
```
public IssueInputParameters addCustomFieldValue(Long customFieldId,
                                                String... values)
```
    Description copied from interface: IssueInputParameters
    
    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 IssueInputParameters.addCustomFieldValue(String, String...).
    
    Specified by:
    
    addCustomFieldValue in interface IssueInputParameters
    
    Parameters:
    
    customFieldId - the unique identifier of the custom field.
    
    values - the custom field values, must be in the format the field expects.
    
    Returns:
    
    this object.
  - addCustomFieldValue
```
public IssueInputParameters addCustomFieldValue(String fullCustomFieldKey,
                                                String... values)
```
    Description copied from interface: IssueInputParameters
    
    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.
    
    Specified by:
    
    addCustomFieldValue in interface IssueInputParameters
    
    Parameters:
    
    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.
    
    Returns:
    
    this object.
  - retainExistingValuesWhenParameterNotProvided
```
public boolean retainExistingValuesWhenParameterNotProvided()
```
    Specified by:
    
    retainExistingValuesWhenParameterNotProvided in interface IssueInputParameters
    
    Returns:
    
    true if the issues value should be retained when a parameter has not been provided, false if the missing parameter should be treated as an update.
  - setRetainExistingValuesWhenParameterNotProvided
```
public void setRetainExistingValuesWhenParameterNotProvided(boolean retain)
```
    Description copied from interface: IssueInputParameters
    
    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 IssueInputParameters.setRetainExistingValuesWhenParameterNotProvided(boolean, boolean) instead.
    
    Specified by:
    
    setRetainExistingValuesWhenParameterNotProvided in interface IssueInputParameters
    
    Parameters:
    
    retain - true if non-provided parameters should have the values retained, false otherwise.
    
    See Also:
    
    IssueInputParameters.retainExistingValuesWhenParameterNotProvided(), IssueInputParameters.setRetainExistingValuesWhenParameterNotProvided(boolean, boolean)
  - setRetainExistingValuesWhenParameterNotProvided
```
public void setRetainExistingValuesWhenParameterNotProvided(boolean retainExistingValues,
                                                            boolean onlyValidatePresentFields)
```
    Description copied from interface: IssueInputParameters
    
    Set flags IssueInputParameters.retainExistingValuesWhenParameterNotProvided() and IssueInputParameters.onlyValidatePresentFieldsWhenRetainingExistingValues().
    The latter is only relevant when the former is true.
    
    Specified by:
    
    setRetainExistingValuesWhenParameterNotProvided in interface IssueInputParameters
    
    Parameters:
    
    retainExistingValues - true if non-provided parameters should have the values retained, false otherwise.
    
    onlyValidatePresentFields - whether or not to only validate present fields
    
    See Also:
    
    IssueInputParameters.onlyValidatePresentFieldsWhenRetainingExistingValues(), IssueService.validateUpdate(ApplicationUser, Long, IssueInputParameters)
  - onlyValidatePresentFieldsWhenRetainingExistingValues
```
public boolean onlyValidatePresentFieldsWhenRetainingExistingValues()
```
    Description copied from interface: IssueInputParameters
    
    Get the flag to designate which fields are to be validated when the 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.
    
    Specified by:
    
    onlyValidatePresentFieldsWhenRetainingExistingValues in interface IssueInputParameters
    
    Returns:
    
    whether or not to only validate present fields
    
    See Also:
    
    IssueService.validateUpdate(ApplicationUser, Long, IssueInputParameters)
  - applyDefaultValuesWhenParameterNotProvided
```
public boolean applyDefaultValuesWhenParameterNotProvided()
```
    Specified by:
    
    applyDefaultValuesWhenParameterNotProvided in interface IssueInputParameters
    
    Returns:
    
    true if default value should be supplied when a parameter has not been provided. false if the default value should not be applied.
  - setApplyDefaultValuesWhenParameterNotProvided
```
public void setApplyDefaultValuesWhenParameterNotProvided(boolean applyDefaultValuesWhenParameterNotProvided)
```
    Specified by:
    
    setApplyDefaultValuesWhenParameterNotProvided in interface IssueInputParameters
    
    Parameters:
    
    applyDefaultValuesWhenParameterNotProvided - true if default value should be supplied when a parameter has not been provided. false if the default value should not be applied.
  - skipScreenCheck
```
public boolean skipScreenCheck()
```
    Description copied from interface: IssueInputParameters
    
    Get the flag to skip screen checks during create, update or transition.
    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.
    
    Specified by:
    
    skipScreenCheck in interface IssueInputParameters
    
    Returns:
    
    whether or not we are skipping screen check
    
    See Also:
    
    IssueService.validateUpdate(ApplicationUser, Long, IssueInputParameters), IssueService.validateCreate(ApplicationUser, IssueInputParameters)
  - setSkipScreenCheck
```
public void setSkipScreenCheck(boolean skipScreenCheck)
```
    Description copied from interface: IssueInputParameters
    
    Set the flag to skip screen checks during create, update or transition.
    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.
    
    Specified by:
    
    setSkipScreenCheck in interface IssueInputParameters
    
    Parameters:
    
    skipScreenCheck - whether or not we are skipping screen check
    
    See Also:
    
    IssueService.validateUpdate(ApplicationUser, Long, IssueInputParameters), IssueService.validateCreate(ApplicationUser, IssueInputParameters)
  - skipLicenceCheck
```
public boolean skipLicenceCheck()
```
    Description copied from interface: IssueInputParameters
    
    Returns true if the skipLicenceCheck flag is set.
    
    Specified by:
    
    skipLicenceCheck in interface IssueInputParameters
    
    Returns:
    
    the value of the skipLicenceCheck flag.
  - setSkipLicenceCheck
```
public void setSkipLicenceCheck(boolean skipLicenceCheck)
```
    Description copied from interface: IssueInputParameters
    
    Set the flag to skip licence checks during create.
    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.
    
    Specified by:
    
    setSkipLicenceCheck in interface IssueInputParameters
    
    Parameters:
    
    skipLicenceCheck - whether or not we are skipping the licence check
  - getCustomFieldValue
```
public String[] getCustomFieldValue(Long customFieldId)
```
    Specified by:
    
    getCustomFieldValue in interface IssueInputParameters
    
    Parameters:
    
    customFieldId - uniquely identifies the custom field value you are looking for.
    
    Returns:
    
    the values for the provided custom field if they exist, null otherwise.
  - getCustomFieldValue
```
public String[] getCustomFieldValue(String fullCustomFieldKey)
```
    Specified by:
    
    getCustomFieldValue in interface IssueInputParameters
    
    Parameters:
    
    fullCustomFieldKey - identifies the custom field values you are looking for.
    
    Returns:
    
    the values for the provided custom field if they exist, null otherwise.
  - getCommentValue
```
public String getCommentValue()
```
    Specified by:
    
    getCommentValue in interface IssueInputParameters
    
    Returns:
    
    the comment string value if it has been set, null otherwise.
  - setComment
```
public IssueInputParameters setComment(String comment)
```
    Description copied from interface: IssueInputParameters
    
    Set a comment value with no visibility restrictions.
    
    Specified by:
    
    setComment in interface IssueInputParameters
    
    Parameters:
    
    comment - the comment value.
    
    Returns:
    
    this object.
  - setComment
```
public IssueInputParameters setComment(String comment,
                                       Long projectRoleId)
```
    Description copied from interface: IssueInputParameters
    
    Set a comment value with a project role restriction.
    
    Specified by:
    
    setComment in interface IssueInputParameters
    
    Parameters:
    
    comment - the comment value.
    
    projectRoleId - the id of the project role the comment must be restricted by.
    
    Returns:
    
    this object.
  - setComment
```
public IssueInputParameters setComment(String comment,
                                       String groupId)
```
    Description copied from interface: IssueInputParameters
    
    Set a comment value with a group restriction.
    
    Specified by:
    
    setComment in interface IssueInputParameters
    
    Parameters:
    
    comment - the comment value.
    
    groupId - the group name that the comment must be restricted by.
    
    Returns:
    
    this object.
  - getActionParameters
```
public Map<String,String[]> getActionParameters()
```
    Description copied from interface: IssueInputParameters
    
    This provides the "web-style" parameters that JIRA fields expect to perform their functions.
    
    Specified by:
    
    getActionParameters in interface IssueInputParameters
    
    Returns:
    
    this is a raw map of "web" style input parameters. These parameters are used to allow the fields to attain the user inputted values. This map is of the style: <field_name> <String [] {value}>.
  - setFieldValuesHolder
```
public void setFieldValuesHolder(Map<String,Object> fieldValuesHolder)
```
    Description copied from interface: IssueInputParameters
    
    If set the validation will use the seed values from this field values holder.
    
    Specified by:
    
    setFieldValuesHolder in interface IssueInputParameters
    
    Parameters:
    
    fieldValuesHolder - provides the seed values for the field values holder.
  - getFieldValuesHolder
```
public Map<String,Object> getFieldValuesHolder()
```
    Specified by:
    
    getFieldValuesHolder in interface IssueInputParameters
    
    Returns:
    
    the provided field values holder or an empty map, never null.
  - getProvidedFields
```
public Collection<String> getProvidedFields()
```
    Specified by:
    
    getProvidedFields in interface IssueInputParameters
    
    Returns:
    
    the field id's that should be validated, null if not specified.
  - setProvidedFields
```
public void setProvidedFields(Collection<String> providedFields)
```
    Description copied from interface: IssueInputParameters
    
    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.
    
    Specified by:
    
    setProvidedFields in interface IssueInputParameters
    
    Parameters:
    
    providedFields - a collection of Field.getId()'s which identify the fields.
  - isFieldSet
```
public boolean isFieldSet(String fieldId)
```
    Specified by:
    
    isFieldSet in interface IssueInputParameters
    
    Parameters:
    
    fieldId - identifies the field in question, this will be the Field.getId().
    
    Returns:
    
    true if a non-null, non-empty value has been set for the field, false if not.
  - addFieldToForcePresent
```
public void addFieldToForcePresent(String fieldId)
```
    Description copied from interface: IssueInputParameters
    
    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.
    
    Specified by:
    
    addFieldToForcePresent in interface IssueInputParameters
    
    Parameters:
    
    fieldId - the id of the field to force to be present
  - isFieldPresent
```
public boolean isFieldPresent(String fieldId)
```
    Specified by:
    
    isFieldPresent in interface IssueInputParameters
    
    Parameters:
    
    fieldId - identifies the field in question, this will be the Field.getId().
    
    Returns:
    
    true if the field has been set, even with an empty value, false if not.
  - addProperty
```
public IssueInputParameters addProperty(String propertyKey,
                                        org.codehaus.jackson.JsonNode propertyValue)
```
    Description copied from interface: IssueInputParameters
    
    Allows properties to be set on issues during create or update
    
    Specified by:
    
    addProperty in interface IssueInputParameters
    
    Parameters:
    
    propertyKey - the key to the property
    
    propertyValue - the JSON property value
    
    Returns:
    
    this object
  - properties
```
public Map<String,org.codehaus.jackson.JsonNode> properties()
```
    Specified by:
    
    properties in interface IssueInputParameters
    
    Returns:
    
    JSON issue properties

Class IssueInputParametersImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IssueInputParametersImpl

IssueInputParametersImpl

Method Detail

setProjectId

getProjectId

setIssueTypeId

getIssueTypeId

setPriorityId

getPriorityId

setResolutionId

getResolutionId

setStatusId

getStatusId

setSummary

getSummary

setDescription

getDescription

setEnvironment

getEnvironment

setAssigneeId

getAssigneeId

setReporterId

getReporterId

setComponentIds

getComponentIds

setFixVersionIds

getFixVersionIds

setAffectedVersionIds

getAffectedVersionIds

setDueDate

getDueDate

setResolutionDate

getResolutionDate

setSecurityLevelId

getSecurityLevelId

setOriginalEstimate

setOriginalEstimate

setRemainingEstimate

setRemainingEstimate

setOriginalAndRemainingEstimate

setOriginalAndRemainingEstimate

getOriginalEstimate

getRemainingEstimate

getRemainingEstimateAsDurationString

getOriginalEstimateAsDurationString

setTimeSpent

getTimeSpent

setHistoryMetadata

getHistoryMetadata

getFormToken

addCustomFieldValue

addCustomFieldValue

retainExistingValuesWhenParameterNotProvided

setRetainExistingValuesWhenParameterNotProvided

setRetainExistingValuesWhenParameterNotProvided

onlyValidatePresentFieldsWhenRetainingExistingValues

applyDefaultValuesWhenParameterNotProvided

setApplyDefaultValuesWhenParameterNotProvided

skipScreenCheck

setSkipScreenCheck

skipLicenceCheck

setSkipLicenceCheck

getCustomFieldValue

getCustomFieldValue

getCommentValue

setComment

setComment

setComment

getActionParameters

setFieldValuesHolder

getFieldValuesHolder

getProvidedFields

setProvidedFields

isFieldSet

addFieldToForcePresent