Issue (redmine-java-api 2.5.0 API)

java.lang.Object
- com.taskadapter.redmineapi.bean.Issue

All Implemented Interfaces:

Identifiable
```
public class Issue
extends java.lang.Object
implements Identifiable
```
Redmine's Issue.
Note that methods returning lists of elements (like getRelations(), getWatchers(), etc return unmodifiable collections. You need to use methods like addRelations() if you want to add elements, e.g.:
```
     issue.addRelations(Collections.singletonList(relation));
 
```

Constructor Summary

Constructors
Constructor and Description

Issue()

Constructors
Constructor and Description
`Issue()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAttachment(Attachment attachment)`
`void`	`addAttachments(java.util.Collection<Attachment> collection)`
`void`	`addChangesets(java.util.Collection<Changeset> changesets)`
`void`	`addCustomField(CustomField customField)` If there is a custom field with the same ID already present in the Issue, the new field replaces the old one.
`void`	`addCustomFields(java.util.Collection<CustomField> customFields)` NOTE: The custom field(s) must have correct database ID set to be saved to Redmine.
`void`	`addJournals(java.util.Collection<Journal> journals)` Issue journals are created automatically when you update existing issues.
`void`	`addRelations(java.util.Collection<IssueRelation> collection)`
`void`	`addWatchers(java.util.Collection<Watcher> watchers)`
`void`	`clearCustomFields()`
`boolean`	`equals(java.lang.Object o)`
`User`	`getAssignee()`
`java.util.Collection<Attachment>`	`getAttachments()` Don't forget to use Include.attachments flag when loading issue from Redmine server:
`User`	`getAuthor()`
`IssueCategory`	`getCategory()`
`java.util.Collection<Changeset>`	`getChangesets()` Don't forget to use Include.changesets flag when loading issue from Redmine server:
`java.util.Date`	`getCreatedOn()`
`java.lang.String`	`getCustomField(java.lang.String fieldName)` Deprecated.
`CustomField`	`getCustomFieldById(int customFieldId)`
`CustomField`	`getCustomFieldByName(java.lang.String customFieldName)`
`java.util.Collection<CustomField>`	`getCustomFields()`
`java.lang.String`	`getDescription()` Description is empty by default, not NULL.
`java.lang.Integer`	`getDoneRatio()`
`java.util.Date`	`getDueDate()`
`java.lang.Float`	`getEstimatedHours()`
`java.lang.Integer`	`getId()`
`java.util.Collection<Journal>`	`getJournals()` Don't forget to use Include.journals flag when loading issue from Redmine server:
`java.lang.String`	`getNotes()`
`java.lang.Integer`	`getParentId()` Parent Issue ID, or NULL for issues without a parent.
`java.lang.Integer`	`getPriorityId()`
`java.lang.String`	`getPriorityText()`
`Project`	`getProject()`
`java.util.Collection<IssueRelation>`	`getRelations()` Relations are only loaded if you include Include.relations when loading the Issue.
`java.lang.Float`	`getSpentHours()`
`java.util.Date`	`getStartDate()`
`java.lang.Integer`	`getStatusId()`
`java.lang.String`	`getStatusName()`
`java.lang.String`	`getSubject()`
`Version`	`getTargetVersion()`
`Tracker`	`getTracker()`
`java.util.Date`	`getUpdatedOn()`
`java.util.Collection<Watcher>`	`getWatchers()` Don't forget to use Include.watchers flag when loading issue from Redmine server:
`int`	`hashCode()`
`void`	`setAssignee(User assignee)`
`void`	`setAuthor(User author)`
`void`	`setCategory(IssueCategory category)`
`void`	`setCreatedOn(java.util.Date createdOn)`
`void`	`setDescription(java.lang.String description)`
`void`	`setDoneRatio(java.lang.Integer doneRatio)`
`void`	`setDueDate(java.util.Date dueDate)`
`void`	`setEstimatedHours(java.lang.Float estimatedTime)`
`void`	`setNotes(java.lang.String notes)`
`void`	`setParentId(java.lang.Integer parentId)`
`void`	`setPriorityId(java.lang.Integer priorityId)`
`void`	`setPriorityText(java.lang.String priority)` Deprecated. This method has no effect when creating issues on Redmine Server, so we might as well just delete it in the future releases.
`void`	`setProject(Project project)`
`void`	`setSpentHours(java.lang.Float spentHours)`
`void`	`setStartDate(java.util.Date startDate)`
`void`	`setStatusId(java.lang.Integer statusId)`
`void`	`setStatusName(java.lang.String statusName)`
`void`	`setSubject(java.lang.String subject)`
`void`	`setTargetVersion(Version version)`
`void`	`setTracker(Tracker tracker)`
`void`	`setUpdatedOn(java.util.Date updatedOn)`
`java.lang.String`	`toString()`

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

- Constructor Detail
  - Issue
```
public Issue()
```
- Method Detail
  - getProject
```
public Project getProject()
```
  - setProject
```
public void setProject(Project project)
```
  - getDoneRatio
```
public java.lang.Integer getDoneRatio()
```
  - setDoneRatio
```
public void setDoneRatio(java.lang.Integer doneRatio)
```
  - getPriorityText
```
public java.lang.String getPriorityText()
```
  - setPriorityText
```
public void setPriorityText(java.lang.String priority)
```
    Deprecated. This method has no effect when creating issues on Redmine Server, so we might as well just delete it in the future releases.
  - getAssignee
```
public User getAssignee()
```
  - setAssignee
```
public void setAssignee(User assignee)
```
  - getEstimatedHours
```
public java.lang.Float getEstimatedHours()
```
  - setEstimatedHours
```
public void setEstimatedHours(java.lang.Float estimatedTime)
```
  - getSpentHours
```
public java.lang.Float getSpentHours()
```
  - setSpentHours
```
public void setSpentHours(java.lang.Float spentHours)
```
  - getParentId
```
public java.lang.Integer getParentId()
```
    Parent Issue ID, or NULL for issues without a parent.
    
    Returns:
    
    NULL, if there's no parent
  - setParentId
```
public void setParentId(java.lang.Integer parentId)
```
  - getId
```
public java.lang.Integer getId()
```
    Specified by:
    
    getId in interface Identifiable
  - getSubject
```
public java.lang.String getSubject()
```
  - setSubject
```
public void setSubject(java.lang.String subject)
```
  - getAuthor
```
public User getAuthor()
```
  - setAuthor
```
public void setAuthor(User author)
```
  - getStartDate
```
public java.util.Date getStartDate()
```
  - setStartDate
```
public void setStartDate(java.util.Date startDate)
```
  - getDueDate
```
public java.util.Date getDueDate()
```
  - setDueDate
```
public void setDueDate(java.util.Date dueDate)
```
  - getTracker
```
public Tracker getTracker()
```
  - setTracker
```
public void setTracker(Tracker tracker)
```
  - getDescription
```
public java.lang.String getDescription()
```
    Description is empty by default, not NULL.
  - setDescription
```
public void setDescription(java.lang.String description)
```
  - getCreatedOn
```
public java.util.Date getCreatedOn()
```
  - setCreatedOn
```
public void setCreatedOn(java.util.Date createdOn)
```
  - getUpdatedOn
```
public java.util.Date getUpdatedOn()
```
  - setUpdatedOn
```
public void setUpdatedOn(java.util.Date updatedOn)
```
  - getStatusId
```
public java.lang.Integer getStatusId()
```
  - setStatusId
```
public void setStatusId(java.lang.Integer statusId)
```
  - getStatusName
```
public java.lang.String getStatusName()
```
  - setStatusName
```
public void setStatusName(java.lang.String statusName)
```
  - getCustomFields
```
public java.util.Collection<CustomField> getCustomFields()
```
    Returns:
    
    unmodifiable collection of Custom Field objects. the collection may be empty, but it is never NULL.
  - clearCustomFields
```
public void clearCustomFields()
```
  - addCustomFields
```
public void addCustomFields(java.util.Collection<CustomField> customFields)
```
    NOTE: The custom field(s) must have correct database ID set to be saved to Redmine. This is Redmine REST API's limitation.
  - addCustomField
```
public void addCustomField(CustomField customField)
```
    If there is a custom field with the same ID already present in the Issue, the new field replaces the old one.
    
    Parameters:
    
    customField - the field to add to the issue.
  - getNotes
```
public java.lang.String getNotes()
```
  - setNotes
```
public void setNotes(java.lang.String notes)
```
    Parameters:
    
    notes - Some comment describing the issue update
  - getJournals
```
public java.util.Collection<Journal> getJournals()
```
    Don't forget to use Include.journals flag when loading issue from Redmine server:
```
     Issue issue = issueManager.getIssueById(3205, Include.journals);
 
```
    Returns:
    
    unmodifiable collection of Journal entries or empty collection if no objects found. Never NULL.
    
    See Also:
    
    Include.journals
  - addJournals
```
public void addJournals(java.util.Collection<Journal> journals)
```
    Issue journals are created automatically when you update existing issues. journal entries are essentially log records for changes you make. you cannot just add log records without making actual changes. this API method is misleading and it should only be used internally by Redmine Json parser when parsing response from server. we should hide it from public. TODO hide this method. https://github.com/taskadapter/redmine-java-api/issues/199
  - getChangesets
```
public java.util.Collection<Changeset> getChangesets()
```
    Don't forget to use Include.changesets flag when loading issue from Redmine server:
```
     Issue issue = issueManager.getIssueById(3205, Include.changesets);
 
```
    Returns:
    
    unmodifiable collection of entries or empty collection if no objects found.
    
    See Also:
    
    Include.changesets
  - addChangesets
```
public void addChangesets(java.util.Collection<Changeset> changesets)
```
  - getWatchers
```
public java.util.Collection<Watcher> getWatchers()
```
    Don't forget to use Include.watchers flag when loading issue from Redmine server:
```
     Issue issue = issueManager.getIssueById(3205, Include.watchers);
 
```
    Returns:
    
    unmodifiable collection of entries or empty collection if no objects found.
    
    See Also:
    
    Include.watchers
  - addWatchers
```
public void addWatchers(java.util.Collection<Watcher> watchers)
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getCustomField
```
@Deprecated
public java.lang.String getCustomField(java.lang.String fieldName)
```
    Deprecated.
    
    Deprecated. Please use the new getCustomFieldByName() method instead because the return value of this method is not consistent with getCustomFieldById().
    
    Returns:
    
    the value or NULL if the field is not found
    
    See Also:
    
    getCustomFieldByName(String customFieldName)
  - getCustomFieldById
```
public CustomField getCustomFieldById(int customFieldId)
```
    Returns:
    
    the custom field with given Id or NULL if the field is not found
  - getCustomFieldByName
```
public CustomField getCustomFieldByName(java.lang.String customFieldName)
```
    Returns:
    
    the custom field with given name or NULL if the field is not found
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getRelations
```
public java.util.Collection<IssueRelation> getRelations()
```
    Relations are only loaded if you include Include.relations when loading the Issue.
```
     Issue issue = issueManager.getIssueById(3205, Include.relations);
 
```
    Since the returned collection is not modifiable, you need to use addRelations() method if you want to add elements, e.g.:
```
     issue.addRelations(Collections.singletonList(relation));
 
```
    Returns:
    
    unmodifiable collection of Relations or EMPTY collection if none found. Never returns NULL.
    
    See Also:
    
    Include.relations
  - addRelations
```
public void addRelations(java.util.Collection<IssueRelation> collection)
```
  - getPriorityId
```
public java.lang.Integer getPriorityId()
```
  - setPriorityId
```
public void setPriorityId(java.lang.Integer priorityId)
```
  - getTargetVersion
```
public Version getTargetVersion()
```
  - getAttachments
```
public java.util.Collection<Attachment> getAttachments()
```
    Don't forget to use Include.attachments flag when loading issue from Redmine server:
```
     Issue issue = issueManager.getIssueById(3205, Include.attachments);
 
```
    Returns:
    
    unmodifiable collection of entries or empty collection if no objects found.
    
    See Also:
    
    Include.attachments
  - addAttachments
```
public void addAttachments(java.util.Collection<Attachment> collection)
```
  - addAttachment
```
public void addAttachment(Attachment attachment)
```
  - setTargetVersion
```
public void setTargetVersion(Version version)
```
  - getCategory
```
public IssueCategory getCategory()
```
  - setCategory
```
public void setCategory(IssueCategory category)
```

Class Issue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Issue

Method Detail

getProject

setProject

getDoneRatio

setDoneRatio

getPriorityText

setPriorityText

getAssignee

setAssignee

getEstimatedHours

setEstimatedHours

getSpentHours

setSpentHours

getParentId

setParentId

getId

getSubject

setSubject

getAuthor

setAuthor

getStartDate

setStartDate

getDueDate

setDueDate

getTracker

setTracker

getDescription

setDescription

getCreatedOn

setCreatedOn

getUpdatedOn

setUpdatedOn

getStatusId

setStatusId

getStatusName

setStatusName

getCustomFields

clearCustomFields

addCustomFields

addCustomField

getNotes

setNotes

getJournals

addJournals

getChangesets

addChangesets

getWatchers

addWatchers

equals

hashCode

getCustomField

getCustomFieldById

getCustomFieldByName

toString

getRelations

addRelations

getPriorityId

setPriorityId

getTargetVersion

getAttachments

addAttachments

addAttachment

setTargetVersion

getCategory

setCategory