|
||||||||||
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.
NOTE: this object is not thread-safe and is only meant to be used as a transport object.
Method Summary | |
---|---|
IssueInputParameters |
addCustomFieldValue(java.lang.Long customFieldId,
java.lang.String... values)
Adds a value for a custom field with the specified id. |
IssueInputParameters |
addCustomFieldValue(java.lang.String fullCustomFieldKey,
java.lang.String... values)
Adds a value for a custom field with the specified full key. |
java.util.Map<java.lang.String,java.lang.String[]> |
getActionParameters()
This provides the "web-style" parameters that JIRA fields expect to perform their functions. |
java.lang.Long[] |
getAffectedVersionIds()
|
java.lang.String |
getAssigneeId()
|
java.lang.String |
getCommentValue()
|
java.lang.Long[] |
getComponentIds()
|
java.lang.String[] |
getCustomFieldValue(java.lang.Long customFieldId)
|
java.lang.String[] |
getCustomFieldValue(java.lang.String fullCustomFieldKey)
|
java.lang.String |
getDescription()
|
java.lang.String |
getDueDate()
|
java.lang.String |
getEnvironment()
|
java.util.Map<java.lang.String,java.lang.Object> |
getFieldValuesHolder()
|
java.lang.Long[] |
getFixVersionIds()
|
java.lang.String |
getIssueTypeId()
|
java.lang.Long |
getOriginalEstimate()
|
java.lang.String |
getPriorityId()
|
java.lang.Long |
getProjectId()
|
java.util.Collection<java.lang.String> |
getProvidedFields()
|
java.lang.String |
getReporterId()
|
java.lang.String |
getResolutionDate()
|
java.lang.String |
getResolutionId()
|
java.lang.Long |
getSecurityLevelId()
|
java.lang.String |
getStatusId()
|
java.lang.String |
getSummary()
|
java.lang.Long |
getTimeSpent()
|
boolean |
isFieldPresent(java.lang.String fieldId)
|
boolean |
isFieldSet(java.lang.String fieldId)
|
boolean |
retainExistingValuesWhenParameterNotProvided()
|
IssueInputParameters |
setAffectedVersionIds(java.lang.Long... affectedVersionIds)
|
IssueInputParameters |
setAssigneeId(java.lang.String assigneeId)
|
IssueInputParameters |
setComment(java.lang.String comment)
Set a comment value with no visibility restrictions. |
IssueInputParameters |
setComment(java.lang.String comment,
java.lang.Long projectRoleId)
Set a comment value with a project role restriction. |
IssueInputParameters |
setComment(java.lang.String comment,
java.lang.String groupId)
Set a comment value with a group restriction. |
IssueInputParameters |
setComponentIds(java.lang.Long... componentIds)
|
IssueInputParameters |
setDescription(java.lang.String description)
|
IssueInputParameters |
setDueDate(java.lang.String dueDate)
|
IssueInputParameters |
setEnvironment(java.lang.String environment)
|
void |
setFieldValuesHolder(java.util.Map<java.lang.String,java.lang.Object> fieldValuesHolder)
If set the validation will use the seed values from this field values holder. |
IssueInputParameters |
setFixVersionIds(java.lang.Long... fixVersionIds)
|
IssueInputParameters |
setIssueTypeId(java.lang.String issueTypeId)
|
IssueInputParameters |
setOriginalEstimate(java.lang.Long originalEstimate)
|
IssueInputParameters |
setPriorityId(java.lang.String priorityId)
|
IssueInputParameters |
setProjectId(java.lang.Long projectId)
|
void |
setProvidedFields(java.util.Collection<java.lang.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 |
setReporterId(java.lang.String reporterId)
|
IssueInputParameters |
setResolutionDate(java.lang.String resolutionDate)
|
IssueInputParameters |
setResolutionId(java.lang.String resolutionId)
|
void |
setRetainExistingValuesWhenParameterNotProvided(boolean retain)
|
IssueInputParameters |
setSecurityLevelId(java.lang.Long securityLevelId)
|
IssueInputParameters |
setStatusId(java.lang.String statusId)
|
IssueInputParameters |
setSummary(java.lang.String summary)
|
IssueInputParameters |
setTimeSpent(java.lang.Long timeSpent)
|
Method Detail |
---|
boolean retainExistingValuesWhenParameterNotProvided()
void setRetainExistingValuesWhenParameterNotProvided(boolean retain)
retain
- true if non-provided parameters should have the values retained, false otherwise.retainExistingValuesWhenParameterNotProvided()
java.lang.String[] getCustomFieldValue(java.lang.Long customFieldId)
customFieldId
- uniquely identifies the custom field value you are looking for.
java.lang.String[] getCustomFieldValue(java.lang.String fullCustomFieldKey)
fullCustomFieldKey
- identifies the custom field values you are looking for.
IssueInputParameters addCustomFieldValue(java.lang.Long customFieldId, java.lang.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(java.lang.String fullCustomFieldKey, java.lang.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.
java.lang.String getCommentValue()
IssueInputParameters setComment(java.lang.String comment)
comment
- the comment value.
IssueInputParameters setComment(java.lang.String comment, java.lang.Long projectRoleId)
comment
- the comment value.projectRoleId
- the id of the project role the comment must be restricted by.
IssueInputParameters setComment(java.lang.String comment, java.lang.String groupId)
comment
- the comment value.groupId
- the group name that the comment must be restricted by.
java.util.Map<java.lang.String,java.lang.String[]> getActionParameters()
void setFieldValuesHolder(java.util.Map<java.lang.String,java.lang.Object> fieldValuesHolder)
fieldValuesHolder
- provides the seed values for the field values holder.java.util.Map<java.lang.String,java.lang.Object> getFieldValuesHolder()
java.util.Collection<java.lang.String> getProvidedFields()
void setProvidedFields(java.util.Collection<java.lang.String> providedFields)
providedFields
- a collection of Field.getId()
's which identify the
fields.boolean isFieldSet(java.lang.String fieldId)
fieldId
- identifies the field in question, this will be the Field.getId()
.
boolean isFieldPresent(java.lang.String fieldId)
fieldId
- identifies the field in question, this will be the Field.getId()
.
IssueInputParameters setProjectId(java.lang.Long projectId)
projectId
- sets the project id for the issue.
java.lang.Long getProjectId()
IssueInputParameters setIssueTypeId(java.lang.String issueTypeId)
issueTypeId
- sets the issue type for the issue.
java.lang.String getIssueTypeId()
IssueInputParameters setPriorityId(java.lang.String priorityId)
priorityId
- sets the priority for the issue.
java.lang.String getPriorityId()
IssueInputParameters setResolutionId(java.lang.String resolutionId)
resolutionId
- sets the resolution for the issue.
java.lang.String getResolutionId()
IssueInputParameters setStatusId(java.lang.String statusId)
statusId
- sets the status of the issue.
java.lang.String getStatusId()
IssueInputParameters setSummary(java.lang.String summary)
summary
- sets the summary for the issue.
java.lang.String getSummary()
IssueInputParameters setDescription(java.lang.String description)
description
- sets the description for the issue.
java.lang.String getDescription()
IssueInputParameters setEnvironment(java.lang.String environment)
environment
- sets the environment of the issue.
java.lang.String getEnvironment()
IssueInputParameters setAssigneeId(java.lang.String assigneeId)
assigneeId
- sets the assignee id for the issue.
java.lang.String getAssigneeId()
IssueInputParameters setReporterId(java.lang.String reporterId)
reporterId
- sets the reporter id for the issue.
java.lang.String getReporterId()
IssueInputParameters setComponentIds(java.lang.Long... componentIds)
componentIds
- sets the components id's on the issue.
java.lang.Long[] getComponentIds()
IssueInputParameters setFixVersionIds(java.lang.Long... fixVersionIds)
fixVersionIds
- sets the fix version id's on the issue.
java.lang.Long[] getFixVersionIds()
IssueInputParameters setAffectedVersionIds(java.lang.Long... affectedVersionIds)
affectedVersionIds
- sets the affected version id's= on the issue.
java.lang.Long[] getAffectedVersionIds()
IssueInputParameters setDueDate(java.lang.String dueDate)
dueDate
- the formatted string that JIRA will accept as a date that will be set on the issue.
java.lang.String getDueDate()
IssueInputParameters setResolutionDate(java.lang.String resolutionDate)
resolutionDate
- the formatted string that JIRA will accept as a date that will be set on the issue.
java.lang.String getResolutionDate()
IssueInputParameters setSecurityLevelId(java.lang.Long securityLevelId)
securityLevelId
- sets the security level id on the issue.
java.lang.Long getSecurityLevelId()
IssueInputParameters setOriginalEstimate(java.lang.Long originalEstimate)
originalEstimate
- sets the original estimate on the issue.
java.lang.Long getOriginalEstimate()
IssueInputParameters setTimeSpent(java.lang.Long timeSpent)
timeSpent
- sets the time spent on the issue.
java.lang.Long getTimeSpent()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |