org.nuiton.jredmine
Interface RedmineService

All Known Implementing Classes:

DefaultRedmineService

public interface RedmineService

The service that mirrors the rails jredmine plugin.

Since:

1.0.0

Author:

chemit

Field Summary

static java.lang.String

ROLE Plexus lookup name

Method Summary

Attachment	addAttachment(java.lang.String projectName, java.lang.String versionName, Attachment attachement) Add a attachment for a given version of a given project.
News	addNews(java.lang.String projectName, News news) Add a news for a given project.
Version	addVersion(java.lang.String projectName, Version version) Add a version for a given project.
Attachment[]	getAttachments(java.lang.String projectName, java.lang.String versionName) Obtain all attachments for a specific version on a given project
IssueCategory[]	getIssueCategories(java.lang.String projectName) Obtain all categories defined on issues for a given project.
IssuePriority[]	getIssuePriorities() Obtain all the priorities defined on a Issue.
Issue[]	getIssues(java.lang.String projectName, java.lang.String versionName) Obtain all issues for a specific version on a given project
IssueStatus[]	getIssueStatuses() Obtain all the statuses defined on a Issue.
News[]	getNews(java.lang.String projectName) Obtain all news defined on a given project.
Project	getProject(java.lang.String projectName) Obtain a project given his name.
Project[]	getProjects() Obtain all accessible projets for the loggued user.
Tracker[]	getTrackers(java.lang.String projectName) Obtain all trackers defined on a given project.
User[]	getUsers(java.lang.String projectName) Obtain all users defined on a given project.
Version	getVersion(java.lang.String projectName, java.lang.String versionName) Obtain a specific version for a given project.
Version[]	getVersions(java.lang.String projectName) Obtain all versions defined on a given project.
Version	nextVersion(java.lang.String projectName, java.lang.String oldVersionName, Version newVersion) Prepare a new version (create it or update it).
Version	updateVersion(java.lang.String projectName, Version version) Update a version for a given project.

Field Detail

ROLE

static final java.lang.String ROLE

Plexus lookup name

Method Detail

getProjects

Project[] getProjects()
                      throws RedmineServiceException

Obtain all accessible projets for the loggued user.

Returns:

all the projects

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Project

getIssuePriorities

IssuePriority[] getIssuePriorities()
                                   throws RedmineServiceException

Obtain all the priorities defined on a Issue.

Note : The priorities are common for all projects.

Returns:

all the issue properties

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

IssuePriority

getIssueStatuses

IssueStatus[] getIssueStatuses()
                               throws RedmineServiceException

Obtain all the statuses defined on a Issue.

Note : The statuses are common for all projects.

Returns:

all the issue statuses

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

IssueStatus

getProject

Project getProject(java.lang.String projectName)
                   throws RedmineServiceException

Obtain a project given his name.

Parameters:

projectName - the name of the project

Returns:

the project

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Project

getIssueCategories

IssueCategory[] getIssueCategories(java.lang.String projectName)
                                   throws RedmineServiceException

Obtain all categories defined on issues for a given project.

Parameters:

projectName - the name of the project

Returns:

the categories of issues for the given project.

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

IssueCategory

getTrackers

Tracker[] getTrackers(java.lang.String projectName)
                      throws RedmineServiceException

Obtain all trackers defined on a given project.

Parameters:

projectName - the name of the project

Returns:

the trackers for the given project.

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Tracker

getNews

News[] getNews(java.lang.String projectName)
               throws RedmineServiceException

Obtain all news defined on a given project.

Parameters:

projectName - the name of the project

Returns:

the news for the given project.

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

News

getUsers

User[] getUsers(java.lang.String projectName)
                throws RedmineServiceException

Obtain all users defined on a given project.

Parameters:

projectName - the name of the project

Returns:

the users for the given project.

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

User

getVersions

Version[] getVersions(java.lang.String projectName)
                      throws RedmineServiceException

Obtain all versions defined on a given project.

Parameters:

projectName - the name of the project

Returns:

the versions of the given project.

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Version

getVersion

Version getVersion(java.lang.String projectName,
                   java.lang.String versionName)
                   throws RedmineServiceException

Obtain a specific version for a given project.

Parameters:

projectName - the name of the project

versionName - the name of the version

Returns:

the version

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Version

getIssues

Issue[] getIssues(java.lang.String projectName,
                  java.lang.String versionName)
                  throws RedmineServiceException

Obtain all issues for a specific version on a given project

Parameters:

projectName - the name of the project

versionName - the name of the version

Returns:

the issues

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Issue

getAttachments

Attachment[] getAttachments(java.lang.String projectName,
                            java.lang.String versionName)
                            throws RedmineServiceException

Obtain all attachments for a specific version on a given project

Parameters:

projectName - the name of the project

versionName - the name of the version

Returns:

the attachments

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Attachment

addVersion

Version addVersion(java.lang.String projectName,
                   Version version)
                   throws RedmineServiceException

Add a version for a given project.

Parameters:

projectName - the name of the project

version - the version to add

Returns:

the added version

Throws:

RedmineServiceException - if any pb while sending and retriving datas to redmine server

See Also:

Version

updateVersion

Version updateVersion(java.lang.String projectName,
                      Version version)
                      throws RedmineServiceException

Update a version for a given project.

Parameters:

projectName - the name of the project

version - the version to update

Returns:

the updated version

Throws:

RedmineServiceException - if any pb while sending and retriving datas to redmine server

See Also:

Version

nextVersion

Version nextVersion(java.lang.String projectName,
                    java.lang.String oldVersionName,
                    Version newVersion)
                    throws RedmineServiceException

Prepare a new version (create it or update it).

If the oldVersionName is given, then all issues unclosed from this old version will be move to the new version.

Parameters:

projectName - the name of the project

oldVersionName - the name of the old version (optional)

newVersion - the newVersion to create or update

Returns:

the created version

Throws:

RedmineServiceException - if any pb while sending and retriving datas to redmine server

See Also:

Version

addNews

News addNews(java.lang.String projectName,
             News news)
             throws RedmineServiceException

Add a news for a given project.

Parameters:

projectName - the name of the project

news - the news to add

Returns:

the added news.

Throws:

RedmineServiceException - if any pb while sending and retriving datas to redmine server

See Also:

News

addAttachment

Attachment addAttachment(java.lang.String projectName,
                         java.lang.String versionName,
                         Attachment attachement)
                         throws RedmineServiceException

Add a attachment for a given version of a given project.

Parameters:

projectName - the name of the project

versionName - the name of the version

attachement - the attachment to add

Returns:

the added attachment

Throws:

RedmineServiceException - if any pb while sending and retriving datas to redmine server

See Also:

Attachment