|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IssueInputParameters
This represents an issue builder and can be used to provide parameters that can be used to create and update
an issue through the IssueService
.
setProvidedFields(java.util.Collection)
with the field
id's that you want to have validated. All other fields that exist on the screen will be populated with the system
default.
To construct a new IssueInputParameters object you can call IssueService.newIssueInputParameters()
.
NOTE: this object is not thread-safe and is only meant to be used as a transport object.
IssueService.newIssueInputParameters()
,
IssueService.newIssueInputParameters(java.util.Map)
Method Detail |
---|
boolean retainExistingValuesWhenParameterNotProvided()
void setRetainExistingValuesWhenParameterNotProvided(boolean retain)
retain
- true if non-provided parameters should have the values retained, false otherwise.retainExistingValuesWhenParameterNotProvided()
boolean applyDefaultValuesWhenParameterNotProvided()
void setApplyDefaultValuesWhenParameterNotProvided(boolean applyDefaults)
applyDefaults
- true if default value should be supplied when a parameter has not been provided. false if the
default value should not be applied.String[] getCustomFieldValue(Long customFieldId)
customFieldId
- uniquely identifies the custom field value you are looking for.
String[] getCustomFieldValue(String fullCustomFieldKey)
fullCustomFieldKey
- identifies the custom field values you are looking for.
IssueInputParameters addCustomFieldValue(Long customFieldId, String... values)
addCustomFieldValue(String, String...)
.
customFieldId
- the unique identifier of the custom field.values
- the custom field values, must be in the format the field expects.
IssueInputParameters addCustomFieldValue(String fullCustomFieldKey, String... values)
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.
String getCommentValue()
IssueInputParameters setComment(String comment)
comment
- the comment value.
IssueInputParameters setComment(String comment, Long projectRoleId)
comment
- the comment value.projectRoleId
- the id of the project role the comment must be restricted by.
IssueInputParameters setComment(String comment, String groupId)
comment
- the comment value.groupId
- the group name that the comment must be restricted by.
Map<String,String[]> getActionParameters()
void setFieldValuesHolder(Map<String,Object> fieldValuesHolder)
fieldValuesHolder
- provides the seed values for the field values holder.Map<String,Object> getFieldValuesHolder()
Collection<String> getProvidedFields()
void setProvidedFields(Collection<String> providedFields)
providedFields
- a collection of Field.getId()
's which identify the
fields.boolean isFieldSet(String fieldId)
fieldId
- identifies the field in question, this will be the Field.getId()
.
boolean isFieldPresent(String fieldId)
fieldId
- identifies the field in question, this will be the Field.getId()
.
IssueInputParameters setProjectId(Long projectId)
projectId
- sets the project id for the issue.
Long getProjectId()
IssueInputParameters setIssueTypeId(String issueTypeId)
issueTypeId
- sets the issue type for the issue.
String getIssueTypeId()
IssueInputParameters setPriorityId(String priorityId)
priorityId
- sets the priority for the issue.
String getPriorityId()
IssueInputParameters setResolutionId(String resolutionId)
resolutionId
- sets the resolution for the issue.
String getResolutionId()
IssueInputParameters setStatusId(String statusId)
statusId
- sets the status of the issue.
String getStatusId()
IssueInputParameters setSummary(String summary)
summary
- sets the summary for the issue.
String getSummary()
IssueInputParameters setDescription(String description)
description
- sets the description for the issue.
String getDescription()
IssueInputParameters setEnvironment(String environment)
environment
- sets the environment of the issue.
String getEnvironment()
IssueInputParameters setAssigneeId(String assigneeId)
assigneeId
- sets the assignee id for the issue.
String getAssigneeId()
IssueInputParameters setReporterId(String reporterId)
reporterId
- sets the reporter id for the issue.
String getReporterId()
IssueInputParameters setComponentIds(Long... componentIds)
componentIds
- sets the components id's on the issue.
Long[] getComponentIds()
IssueInputParameters setFixVersionIds(Long... fixVersionIds)
fixVersionIds
- sets the fix version id's on the issue.
Long[] getFixVersionIds()
IssueInputParameters setAffectedVersionIds(Long... affectedVersionIds)
affectedVersionIds
- sets the affected version id's= on the issue.
Long[] getAffectedVersionIds()
IssueInputParameters setDueDate(String dueDate)
dueDate
- the formatted string that JIRA will accept as a date that will be set on the issue.
String getDueDate()
IssueInputParameters setResolutionDate(String resolutionDate)
resolutionDate
- the formatted string that JIRA will accept as a date that will be set on the issue.
String getResolutionDate()
IssueInputParameters setSecurityLevelId(Long securityLevelId)
securityLevelId
- sets the security level id on the issue.
Long getSecurityLevelId()
IssueInputParameters setOriginalEstimate(Long originalEstimate)
originalEstimate
- sets the original estimate on the issue.
Long getOriginalEstimate()
IssueInputParameters setTimeSpent(Long timeSpent)
timeSpent
- sets the time spent on the issue.
Long getTimeSpent()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |