com.taskadapter.redmineapi.bean

Class Issue

java.lang.Object

com.taskadapter.redmineapi.bean.Issue

All Implemented Interfaces:

FluentStyle, Identifiable

public class Issue
extends java.lang.Object
implements Identifiable, FluentStyle

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));
 

See Also:

http://www.redmine.org/projects/redmine/wiki/Rest_Issues

Field Summary

Fields

Modifier and Type	Field and Description
static Property<java.lang.Integer>	ASSIGNEE_ID
static Property<java.lang.String>	ASSIGNEE_NAME
static Property<java.util.Set<Attachment>>	ATTACHMENTS
static Property<java.lang.Integer>	AUTHOR_ID
static Property<java.lang.String>	AUTHOR_NAME
static Property<java.util.Set<Changeset>>	CHANGESETS
static Property<java.util.Set<Issue>>	CHILDREN
static Property<java.util.Date>	CLOSED_ON
static Property<java.util.Date>	CREATED_ON
static Property<java.util.Set<CustomField>>	CUSTOM_FIELDS can't have two custom fields with the same ID in the collection, that's why it is declared as a Set, not a List.
static Property<java.lang.Integer>	DATABASE_ID
static Property<java.lang.String>	DESCRIPTION
static Property<java.lang.Integer>	DONE_RATIO
static Property<java.util.Date>	DUE_DATE
static Property<java.lang.Float>	ESTIMATED_HOURS
static Property<IssueCategory>	ISSUE_CATEGORY
static Property<java.util.Set<Journal>>	JOURNALS
static Property<java.lang.String>	NOTES Some comment describing an issue update.
static Property<java.lang.Integer>	PARENT_ID
static Property<java.lang.Integer>	PRIORITY_ID
static Property<java.lang.String>	PRIORITY_TEXT
static Property<java.lang.Boolean>	PRIVATE_ISSUE
static Property<java.lang.Boolean>	PRIVATE_NOTES
static Property<java.lang.Integer>	PROJECT_ID
static Property<java.lang.String>	PROJECT_NAME
static Property<java.util.Set<IssueRelation>>	RELATIONS
static Property<java.lang.Float>	SPENT_HOURS
static Property<java.util.Date>	START_DATE
static Property<java.lang.Integer>	STATUS_ID
static Property<java.lang.String>	STATUS_NAME
static Property<java.lang.String>	SUBJECT
static Property<Version>	TARGET_VERSION
static Property<Tracker>	TRACKER
static Property<java.util.Date>	UPDATED_ON
static Property<java.util.Set<Watcher>>	WATCHERS

Constructor Summary

Constructors

Constructor and Description
Issue()
Issue(Transport transport, int projectId) Each Issue object must have project Id set in order for Redmine 3.x to accept it via REST API.
Issue(Transport transport, int projectId, java.lang.String subject)

Method Summary

Modifier and Type	Method and Description
Issue	addAttachment(Attachment attachment)
Issue	addAttachments(java.util.Collection<Attachment> collection)
Issue	addChangesets(java.util.Collection<Changeset> changesets)
Issue	addChildren(java.util.Collection<Issue> children)
Issue	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.
Issue	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.
Issue	addRelations(java.util.Collection<IssueRelation> collection)
void	addWatcher(int watcherId)
Issue	addWatchers(java.util.Collection<Watcher> watchers)
Issue	clearCustomFields()
Issue	create()
void	delete()
void	deleteWatcher(int watcherId)
boolean	equals(java.lang.Object o) Issues are considered equal if their IDs are equal.
java.lang.Integer	getAssigneeId() Redmine can be configured to allow group assignments for issues: Configuration option: Settings -> Issue Tracking -> Allow issue assignment to groups
java.lang.String	getAssigneeName()
java.util.Collection<Attachment>	getAttachments() Don't forget to use Include.attachments flag when loading issue from Redmine server:
java.lang.Integer	getAuthorId()
java.lang.String	getAuthorName()
IssueCategory	getCategory()
java.util.Collection<Changeset>	getChangesets() Don't forget to use Include.changesets flag when loading issue from Redmine server:
java.util.Collection<Issue>	getChildren() Don't forget to use Include.children flag when loading issue from Redmine server:
java.util.Date	getClosedOn()
java.util.Date	getCreatedOn()
CustomField	getCustomFieldById(int customFieldId)
CustomField	getCustomFieldByName(java.lang.String customFieldName)
java.util.Collection<CustomField>	getCustomFields()
java.lang.String	getDescription()
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() Deprecated.
java.lang.Integer	getParentId() Parent Issue ID, or NULL for issues without a parent.
java.lang.Integer	getPriorityId()
java.lang.String	getPriorityText()
java.lang.Integer	getProjectId()
java.lang.String	getProjectName()
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()
PropertyStorage	getStorage()
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()
boolean	isPrivateIssue() Default value is not determines.
boolean	isPrivateNotes()
Issue	setAssigneeId(java.lang.Integer assigneeId)
Issue	setAssigneeName(java.lang.String assigneeName)
Issue	setAuthorId(java.lang.Integer id)
Issue	setAuthorName(java.lang.String name)
Issue	setCategory(IssueCategory category)
Issue	setClosedOn(java.util.Date closedOn)
Issue	setCreatedOn(java.util.Date createdOn)
Issue	setDescription(java.lang.String description)
Issue	setDoneRatio(java.lang.Integer doneRatio)
Issue	setDueDate(java.util.Date dueDate)
Issue	setEstimatedHours(java.lang.Float estimatedTime)
Issue	setId(java.lang.Integer id)
Issue	setNotes(java.lang.String notes)
Issue	setParentId(java.lang.Integer parentId)
Issue	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.
Issue	setPrivateIssue(boolean privateIssue)
Issue	setPrivateNotes(boolean privateNotes)
Issue	setProjectId(java.lang.Integer projectId)
Issue	setProjectName(java.lang.String name)
Issue	setSpentHours(java.lang.Float spentHours)
Issue	setStartDate(java.util.Date startDate)
Issue	setStatusId(java.lang.Integer statusId)
Issue	setStatusName(java.lang.String statusName)
Issue	setSubject(java.lang.String subject)
Issue	setTargetVersion(Version version)
Issue	setTracker(Tracker tracker)
void	setTransport(Transport transport)
Issue	setUpdatedOn(java.util.Date updatedOn)
java.lang.String	toString()
void	update()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DATABASE_ID

public static final Property<java.lang.Integer> DATABASE_ID

SUBJECT

public static final Property<java.lang.String> SUBJECT

START_DATE

public static final Property<java.util.Date> START_DATE

DUE_DATE

public static final Property<java.util.Date> DUE_DATE

CREATED_ON

public static final Property<java.util.Date> CREATED_ON

UPDATED_ON

public static final Property<java.util.Date> UPDATED_ON

DONE_RATIO

public static final Property<java.lang.Integer> DONE_RATIO

PARENT_ID

public static final Property<java.lang.Integer> PARENT_ID

PRIORITY_ID

public static final Property<java.lang.Integer> PRIORITY_ID

ESTIMATED_HOURS

public static final Property<java.lang.Float> ESTIMATED_HOURS

SPENT_HOURS

public static final Property<java.lang.Float> SPENT_HOURS

ASSIGNEE_ID

public static final Property<java.lang.Integer> ASSIGNEE_ID

ASSIGNEE_NAME

public static final Property<java.lang.String> ASSIGNEE_NAME

NOTES

public static final Property<java.lang.String> NOTES

Some comment describing an issue update.

PRIVATE_NOTES

public static final Property<java.lang.Boolean> PRIVATE_NOTES

PRIORITY_TEXT

public static final Property<java.lang.String> PRIORITY_TEXT

PROJECT_ID

public static final Property<java.lang.Integer> PROJECT_ID

PROJECT_NAME

public static final Property<java.lang.String> PROJECT_NAME

AUTHOR_ID

public static final Property<java.lang.Integer> AUTHOR_ID

AUTHOR_NAME

public static final Property<java.lang.String> AUTHOR_NAME

TRACKER

public static final Property<Tracker> TRACKER

DESCRIPTION

public static final Property<java.lang.String> DESCRIPTION

CLOSED_ON

public static final Property<java.util.Date> CLOSED_ON

STATUS_ID

public static final Property<java.lang.Integer> STATUS_ID

STATUS_NAME

public static final Property<java.lang.String> STATUS_NAME

TARGET_VERSION

public static final Property<Version> TARGET_VERSION

ISSUE_CATEGORY

public static final Property<IssueCategory> ISSUE_CATEGORY

PRIVATE_ISSUE

public static final Property<java.lang.Boolean> PRIVATE_ISSUE

CUSTOM_FIELDS

public static final Property<java.util.Set<CustomField>> CUSTOM_FIELDS

can't have two custom fields with the same ID in the collection, that's why it is declared as a Set, not a List.

JOURNALS

public static final Property<java.util.Set<Journal>> JOURNALS

RELATIONS

public static final Property<java.util.Set<IssueRelation>> RELATIONS

ATTACHMENTS

public static final Property<java.util.Set<Attachment>> ATTACHMENTS

CHANGESETS

public static final Property<java.util.Set<Changeset>> CHANGESETS

WATCHERS

public static final Property<java.util.Set<Watcher>> WATCHERS

CHILDREN

public static final Property<java.util.Set<Issue>> CHILDREN

Constructor Detail

Issue

public Issue()

Issue

public Issue(Transport transport,
             int projectId)

Each Issue object must have project Id set in order for Redmine 3.x to accept it via REST API.

Issue

public Issue(Transport transport,
             int projectId,
             java.lang.String subject)

Parameters:

projectId - Each Issue object must have project Id set in order for Redmine 3.x to accept it via REST API.

Method Detail

getProjectId

public java.lang.Integer getProjectId()

setProjectId

public Issue setProjectId(java.lang.Integer projectId)

getProjectName

public java.lang.String getProjectName()

setProjectName

public Issue setProjectName(java.lang.String name)

setId

public Issue setId(java.lang.Integer id)

Parameters:

id - database ID.

getDoneRatio

public java.lang.Integer getDoneRatio()

setDoneRatio

public Issue 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.

getAssigneeId

public java.lang.Integer getAssigneeId()

Redmine can be configured to allow group assignments for issues: Configuration option: Settings -> Issue Tracking -> Allow issue assignment to groups

An assignee can be a user or a group

setAssigneeId

public Issue setAssigneeId(java.lang.Integer assigneeId)

getAssigneeName

public java.lang.String getAssigneeName()

setAssigneeName

public Issue setAssigneeName(java.lang.String assigneeName)

getEstimatedHours

public java.lang.Float getEstimatedHours()

setEstimatedHours

public Issue setEstimatedHours(java.lang.Float estimatedTime)

getSpentHours

public java.lang.Float getSpentHours()

setSpentHours

public Issue 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 Issue setParentId(java.lang.Integer parentId)

getId

public java.lang.Integer getId()

Specified by:

getId in interface Identifiable

Returns:

database id for this object. can be NULL for Issues not added to Redmine yet

getSubject

public java.lang.String getSubject()

setSubject

public Issue setSubject(java.lang.String subject)

getStartDate

public java.util.Date getStartDate()

setStartDate

public Issue setStartDate(java.util.Date startDate)

getDueDate

public java.util.Date getDueDate()

setDueDate

public Issue setDueDate(java.util.Date dueDate)

getAuthorId

public java.lang.Integer getAuthorId()

setAuthorId

public Issue setAuthorId(java.lang.Integer id)

getAuthorName

public java.lang.String getAuthorName()

setAuthorName

public Issue setAuthorName(java.lang.String name)

getTracker

public Tracker getTracker()

setTracker

public Issue setTracker(Tracker tracker)

getDescription

public java.lang.String getDescription()

setDescription

public Issue setDescription(java.lang.String description)

getCreatedOn

public java.util.Date getCreatedOn()

setCreatedOn

public Issue setCreatedOn(java.util.Date createdOn)

getUpdatedOn

public java.util.Date getUpdatedOn()

setUpdatedOn

public Issue setUpdatedOn(java.util.Date updatedOn)

getClosedOn

public java.util.Date getClosedOn()

setClosedOn

public Issue setClosedOn(java.util.Date closedOn)

getStatusId

public java.lang.Integer getStatusId()

setStatusId

public Issue setStatusId(java.lang.Integer statusId)

getStatusName

public java.lang.String getStatusName()

setStatusName

public Issue 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 Issue clearCustomFields()

addCustomFields

public Issue 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 requirement.

addCustomField

public Issue 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

@Deprecated
public java.lang.String getNotes()

Deprecated.

setNotes

public Issue setNotes(java.lang.String notes)

Parameters:

notes - Some comment describing the issue update

isPrivateNotes

public boolean isPrivateNotes()

setPrivateNotes

public Issue setPrivateNotes(boolean privateNotes)

Parameters:

privateNotes - mark note as private

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 Issue 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 Issue addWatchers(java.util.Collection<Watcher> watchers)

getChildren

public java.util.Collection<Issue> getChildren()

Don't forget to use Include.children flag when loading issue from Redmine server:

     Issue issue = issueManager.getIssueById(3205, Include.children);
 

Returns:

Collection of entries or empty collection if no objects found.

See Also:

Include.children

addChildren

public Issue addChildren(java.util.Collection<Issue> children)

equals

public boolean equals(java.lang.Object o)

Issues are considered equal if their IDs are equal. what about two issues with null ids?

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

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 Issue addRelations(java.util.Collection<IssueRelation> collection)

getPriorityId

public java.lang.Integer getPriorityId()

setPriorityId

public Issue 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 Issue addAttachments(java.util.Collection<Attachment> collection)

addAttachment

public Issue addAttachment(Attachment attachment)

setTargetVersion

public Issue setTargetVersion(Version version)

getCategory

public IssueCategory getCategory()

setCategory

public Issue setCategory(IssueCategory category)

isPrivateIssue

public boolean isPrivateIssue()

Default value is not determines. it's up to the server what it thinks the default value is if not set.

setPrivateIssue

public Issue setPrivateIssue(boolean privateIssue)

getStorage

public PropertyStorage getStorage()

create

public Issue create()
             throws RedmineException

Returns:

the newly created Issue.

Throws:

RedmineAuthenticationException - invalid or no API access key is used with the server, which requires authorization. Check the constructor arguments.

NotFoundException - the required project is not found

RedmineException

update

public void update()
            throws RedmineException

Throws:

RedmineException

delete

public void delete()
            throws RedmineException

Throws:

RedmineException

addWatcher

public void addWatcher(int watcherId)
                throws RedmineException

Throws:

RedmineException

deleteWatcher

public void deleteWatcher(int watcherId)
                   throws RedmineException

Throws:

RedmineException

setTransport

public void setTransport(Transport transport)

Specified by:

setTransport in interface FluentStyle