IssueManager (redmine-java-api 2.6.0 API)

java.lang.Object
- com.taskadapter.redmineapi.IssueManager

public class IssueManager
extends java.lang.Object

Works with Issues, Time Entries, Issue Statuses, Issue Relations.

Obtain it via RedmineManager:

 RedmineManager redmineManager = RedmineManagerFactory.createWithUserAuth(redmineURI, login, password);
 IssueManager issueManager = redmineManager.getIssueManager();

Sample usage:

 Issue issue = issueManager.getIssueById(3205, Include.journals, Include.relations, Include.attachments);
 System.out.println(issue.getJournals());

See Also:: RedmineManager.getIssueManager()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addWatcherToIssue(Watcher watcher, Issue issue)`
`IssueCategory`	`createCategory(IssueCategory category)` creates a new `IssueCategory` for the `Project` contained.
`Issue`	`createIssue(Issue issue)` Sample usage:
`Issue`	`createIssue(java.lang.String projectKey, Issue issue)` Deprecated.
`IssueRelation`	`createRelation(java.lang.Integer issueId, java.lang.Integer issueToId, java.lang.String type)`
`TimeEntry`	`createTimeEntry(TimeEntry obj)`
`void`	`deleteCategory(IssueCategory category)` deletes an `IssueCategory`.
`void`	`deleteIssue(java.lang.Integer id)`
`void`	`deleteIssueRelations(Issue redmineIssue)` Delete all issue's relations
`void`	`deleteIssueRelationsByIssueId(java.lang.Integer issueId)` Delete relations for the given issue ID.
`void`	`deleteRelation(java.lang.Integer id)` Delete Issue Relation with the given Id.
`void`	`deleteTimeEntry(java.lang.Integer id)`
`void`	`deleteWatcherFromIssue(Watcher watcher, Issue issue)`
`java.util.List<IssueCategory>`	`getCategories(int projectID)` delivers a list of `IssueCategory`s of a `Project`
`Issue`	`getIssueById(java.lang.Integer id, Include... include)`
`java.util.List<IssuePriority>`	`getIssuePriorities()`
`java.util.List<Issue>`	`getIssues(java.util.Map<java.lang.String,java.lang.String> parameters)` Direct method to search for issues using any Redmine REST API parameters you want.
`java.util.List<Issue>`	`getIssues(java.lang.String projectKey, java.lang.Integer queryId, Include... include)`
`java.util.List<Issue>`	`getIssuesBySummary(java.lang.String projectKey, java.lang.String summaryField)` There could be several issues with the same summary, so the method returns List.
`java.util.List<SavedQuery>`	`getSavedQueries()` Get all "saved queries" available to the current user.
`java.util.List<SavedQuery>`	`getSavedQueries(java.lang.String projectKey)` Get "saved queries" for the given project available to the current user.
`java.util.List<IssueStatus>`	`getStatuses()` Delivers a list of existing `IssueStatus`es.
`java.util.List<TimeEntry>`	`getTimeEntries()`
`java.util.List<TimeEntry>`	`getTimeEntriesForIssue(java.lang.Integer issueId)`
`TimeEntry`	`getTimeEntry(java.lang.Integer id)`
`java.util.List<TimeEntryActivity>`	`getTimeEntryActivities()`
`java.util.List<Tracker>`	`getTrackers()`
`void`	`update(Issue obj)`
`void`	`update(TimeEntry obj)`

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

- Method Detail
  - getIssuesBySummary
```
public java.util.List<Issue> getIssuesBySummary(java.lang.String projectKey,
                                                java.lang.String summaryField)
                                         throws RedmineException
```
    There could be several issues with the same summary, so the method returns List.
    
    Returns:
    
    empty list if not issues with this summary field exist, never NULL
    
    Throws:
    
    RedmineAuthenticationException - invalid or no API access key is used with the server, which requires authorization. Check the constructor arguments.
    
    NotFoundException
    
    RedmineException
  - getIssues
```
public java.util.List<Issue> getIssues(java.util.Map<java.lang.String,java.lang.String> parameters)
                                throws RedmineException
```
    Direct method to search for issues using any Redmine REST API parameters you want.
    Unlike other getXXXObjects() methods in this library, this one does NOT handle paging for you so you have to provide "offset" and "limit" parameters if you want to control paging.
    Sample usage:
```
     final Map params = new HashMap();
     params.put("project_id", projectId);
     params.put("subject", "~free_form_search");
     final List issues = issueManager.getIssues(params);
     
```
    Parameters:
    
    parameters - the http parameters key/value pairs to append to the rest api request
    
    Returns:
    
    empty list if no issues found matching given parameters
    
    Throws:
    
    RedmineAuthenticationException - invalid or no API access key is used with the server, which requires authorization. Check the constructor arguments.
    
    RedmineException
  - getIssueById
```
public Issue getIssueById(java.lang.Integer id,
                          Include... include)
                   throws RedmineException
```
    Parameters:
    
    id - Redmine issue Id
    
    include - list of "includes". e.g. "relations", "journals", ...
    
    Returns:
    
    Issue object. never Null: an exception is thrown if the issue is not found (see Throws section).
    
    Throws:
    
    RedmineAuthenticationException - invalid or no API access key is used with the server, which requires authorization. Check the constructor arguments.
    
    NotFoundException - the issue with the given id is not found on the server
    
    RedmineException
  - addWatcherToIssue
```
public void addWatcherToIssue(Watcher watcher,
                              Issue issue)
                       throws RedmineException
```
    Throws:
    
    RedmineException
  - deleteWatcherFromIssue
```
public void deleteWatcherFromIssue(Watcher watcher,
                                   Issue issue)
                            throws RedmineException
```
    Throws:
    
    RedmineException
  - createIssue
```
@Deprecated
public Issue createIssue(java.lang.String projectKey,
                                     Issue issue)
                              throws RedmineException
```
    Deprecated.
    DEPRECATED. use createIssue(Issue issue) instead. "projectKey" parameter required by this method duplicates what is already available in "issue" parameter. Also, some Redmine APIs require project database ID instead of the string key (e.g. when updating Issue). To keep things consistent, we propose using project database IDs for other operations as well, like for creating new issues. Which means you need to create a Project instance with the project numeric ID and set it to the new Issue object - see createIssue(Issue issue) method.
    Sample usage:
```
 
   Issue issueToCreate = IssueFactory.create();
   issueToCreate.setSubject("This is the summary line 123");
   Issue newIssue = mgr.createIssue(PROJECT_KEY, issueToCreate);
 
 
```
    Parameters:
    
    projectKey - The project "identifier". This is a string key like "project-ABC", NOT a database numeric ID.
    
    issue - the Issue object to create on the server.
    
    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 project with the given projectKey is not found
    
    RedmineException
    
    See Also:
    
    createIssue(com.taskadapter.redmineapi.bean.Issue)
  - createIssue
```
public Issue createIssue(Issue issue)
                  throws RedmineException
```
    Sample usage:
```
 
   Issue issueToCreate = IssueFactory.create(projectDatabaseId, subject);
   Issue newIssue = mgr.createIssue(issueToCreate);
 
 
```
    Parameters:
    
    issue - the Issue object to create on the server.
    
    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 project is not found
    
    RedmineException
  - deleteIssue
```
public void deleteIssue(java.lang.Integer id)
                 throws RedmineException
```
    Throws:
    
    RedmineException
  - getIssues
```
public java.util.List<Issue> getIssues(java.lang.String projectKey,
                                       java.lang.Integer queryId,
                                       Include... include)
                                throws RedmineException
```
    Parameters:
    
    projectKey - ignored if NULL
    
    queryId - id of the saved query in Redmine. the query must be accessible to the user represented by the API access key (if the Redmine project requires authorization). This parameter is optional, NULL can be provided to get all available issues.
    
    Returns:
    
    list of Issue objects
    
    Throws:
    
    RedmineAuthenticationException - invalid or no API access key is used with the server, which requires authorization. Check the constructor arguments.
    
    RedmineException
    
    See Also:
    
    Issue
  - createRelation
```
public IssueRelation createRelation(java.lang.Integer issueId,
                                    java.lang.Integer issueToId,
                                    java.lang.String type)
                             throws RedmineException
```
    Parameters:
    
    issueId - id of the source issue
    
    issueToId - if of the target issue
    
    type - type of the relation. e.g. "precedes". see IssueRelation.TYPE for possible types.
    
    Returns:
    
    newly created IssueRelation instance.
    
    Throws:
    
    RedmineException
    
    See Also:
    
    IssueRelation.TYPE
  - deleteRelation
```
public void deleteRelation(java.lang.Integer id)
                    throws RedmineException
```
    Delete Issue Relation with the given Id.
    
    Throws:
    
    RedmineException
  - deleteIssueRelations
```
public void deleteIssueRelations(Issue redmineIssue)
                          throws RedmineException
```
    Delete all issue's relations
    
    Throws:
    
    RedmineException
  - deleteIssueRelationsByIssueId
```
public void deleteIssueRelationsByIssueId(java.lang.Integer issueId)
                                   throws RedmineException
```
    Delete relations for the given issue ID.
    
    Parameters:
    
    issueId - issue ID
    
    Throws:
    
    RedmineException
  - getIssuePriorities
```
public java.util.List<IssuePriority> getIssuePriorities()
                                                 throws RedmineException
```
    Throws:
    
    RedmineException
  - getTimeEntries
```
public java.util.List<TimeEntry> getTimeEntries()
                                         throws RedmineException
```
    Throws:
    
    RedmineException
  - getTimeEntry
```
public TimeEntry getTimeEntry(java.lang.Integer id)
                       throws RedmineException
```
    Parameters:
    
    id - the database Id of the TimeEntry record
    
    Throws:
    
    RedmineException
  - getTimeEntriesForIssue
```
public java.util.List<TimeEntry> getTimeEntriesForIssue(java.lang.Integer issueId)
                                                 throws RedmineException
```
    Throws:
    
    RedmineException
  - createTimeEntry
```
public TimeEntry createTimeEntry(TimeEntry obj)
                          throws RedmineException
```
    Throws:
    
    RedmineException
  - deleteTimeEntry
```
public void deleteTimeEntry(java.lang.Integer id)
                     throws RedmineException
```
    Throws:
    
    RedmineException
  - getTimeEntryActivities
```
public java.util.List<TimeEntryActivity> getTimeEntryActivities()
                                                         throws RedmineException
```
    Throws:
    
    RedmineException
  - update
```
public void update(TimeEntry obj)
            throws RedmineException
```
    Throws:
    
    RedmineException
  - update
```
public void update(Issue obj)
            throws RedmineException
```
    Throws:
    
    RedmineException
  - getCategories
```
public java.util.List<IssueCategory> getCategories(int projectID)
                                            throws RedmineException
```
    delivers a list of IssueCategorys of a Project
    
    Parameters:
    
    projectID - the ID of the Project
    
    Returns:
    
    the list of IssueCategorys of the Project
    
    Throws:
    
    RedmineAuthenticationException - thrown in case something went wrong while trying to login
    
    RedmineException - thrown in case something went wrong in Redmine
    
    NotFoundException - thrown in case an object can not be found
  - createCategory
```
public IssueCategory createCategory(IssueCategory category)
                             throws RedmineException
```
    creates a new IssueCategory for the Project contained.
    Pre-condition: the attribute Project for the IssueCategory must not be null!
    
    Parameters:
    
    category - the IssueCategory. Must contain a Project.
    
    Returns:
    
    the new IssueCategory created by Redmine
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown in case the category does not contain a project.
    
    RedmineAuthenticationException - thrown in case something went wrong while trying to login
    
    RedmineException - thrown in case something went wrong in Redmine
    
    NotFoundException - thrown in case an object can not be found
  - deleteCategory
```
public void deleteCategory(IssueCategory category)
                    throws RedmineException
```
    deletes an IssueCategory.
    
    Parameters:
    
    category - the IssueCategory.
    
    Throws:
    
    RedmineAuthenticationException - thrown in case something went wrong while trying to login
    
    RedmineException - thrown in case something went wrong in Redmine
    
    NotFoundException - thrown in case an object can not be found
  - getStatuses
```
public java.util.List<IssueStatus> getStatuses()
                                        throws RedmineException
```
    Delivers a list of existing IssueStatuses.
    
    Returns:
    
    a list of existing IssueStatuses.
    
    Throws:
    
    RedmineAuthenticationException - thrown in case something went wrong while trying to login
    
    RedmineException - thrown in case something went wrong in Redmine
    
    NotFoundException - thrown in case an object can not be found
  - getTrackers
```
public java.util.List<Tracker> getTrackers()
                                    throws RedmineException
```
    Returns:
    
    a list of all Trackers available (like "Bug", "Task", "Feature")
    
    Throws:
    
    RedmineAuthenticationException - thrown in case something went wrong while trying to login
    
    RedmineException - thrown in case something went wrong in Redmine
    
    NotFoundException - thrown in case an object can not be found
  - getSavedQueries
```
public java.util.List<SavedQuery> getSavedQueries(java.lang.String projectKey)
                                           throws RedmineException
```
    Get "saved queries" for the given project available to the current user.
    This REST API feature was added in Redmine 1.3.0. See http://www.redmine.org/issues/5737
    
    Throws:
    
    RedmineException
  - getSavedQueries
```
public java.util.List<SavedQuery> getSavedQueries()
                                           throws RedmineException
```
    Get all "saved queries" available to the current user.
    This REST API feature was added in Redmine 1.3.0. See http://www.redmine.org/issues/5737
    
    Throws:
    
    RedmineException

Class IssueManager

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getIssuesBySummary

getIssues

getIssueById

addWatcherToIssue

deleteWatcherFromIssue

createIssue

createIssue

deleteIssue

getIssues

createRelation

deleteRelation

deleteIssueRelations

deleteIssueRelationsByIssueId

getIssuePriorities

getTimeEntries

getTimeEntry

getTimeEntriesForIssue

createTimeEntry

deleteTimeEntry

getTimeEntryActivities

update

update

getCategories

createCategory

deleteCategory

getStatuses

getTrackers

getSavedQueries

getSavedQueries