org.nuiton.jredmine.service

Interface RedmineLogguedService

All Known Subinterfaces:

RedmineService

All Known Implementing Classes:

DefaultRedmineService

public interface RedmineLogguedService

Contract of all redmine operations that needs a login to be performed (for both public or private projects).

A default implementation is offered in DefaultRedmineService.

Created: 2 janv. 2010

Since:

1.0.3

Author:

tchemit

See Also:

RedmineAnonymousService, RedmineService

Method Summary

Methods

Modifier and Type	Method and Description
Attachment	addAttachment(String projectName, String versionName, Attachment attachement) Add a attachment for a given version of a given project.
TimeEntry	addIssueTimeEntry(String projectName, String issueId, TimeEntry entry) Add a new time entry to the given issue for the given project and return the updated time entry.
News	addNews(String projectName, News news) Add a news for a given project.
Version	addVersion(String projectName, Version version) Add a version for a given project.
User	getCurrentUser() Obtain the redmine user from the credentials given in the service configuration.
Project[]	getUserProjects() Obtain for the loggued user, all projets where he belongs.
Version	nextVersion(String projectName, String oldVersionName, Version newVersion) Prepare a new version (create it or update it).
Version	updateVersion(String projectName, Version version) Update a version for a given project.

Method Detail

getCurrentUser

User getCurrentUser()
                    throws RedmineServiceException

Obtain the redmine user from the credentials given in the service configuration.

Returns:

the current user using the credentials of the service configuration

Throws:

RedmineServiceException - if any pb

Since:

1.7

getUserProjects

Project[] getUserProjects()
                          throws RedmineServiceException

Obtain for the loggued user, all projets where he belongs.

Note: This method requires to be loggued on redmine server.

Returns:

all the projects belonged by the loggued user

Throws:

RedmineServiceException - if any pb while retriving datas

Since:

1.0.3

See Also:

Project

addVersion

Version addVersion(String projectName,
                 Version version)
                   throws RedmineServiceException

Add a version for a given project.

b>Note: This method requires to be loggued on redmine server.

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(String projectName,
                    Version version)
                      throws RedmineServiceException

Update a version for a given project.

b>Note: This method requires to be loggued on redmine server.

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(String projectName,
                  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.

b>Note: This method requires to be loggued on redmine server.

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(String projectName,
           News news)
             throws RedmineServiceException

Add a news for a given project.

b>Note: This method requires to be loggued on redmine server.

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(String projectName,
                       String versionName,
                       Attachment attachement)
                         throws RedmineServiceException

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

b>Note: This method requires to be loggued on redmine server.

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

addIssueTimeEntry

TimeEntry addIssueTimeEntry(String projectName,
                          String issueId,
                          TimeEntry entry)
                            throws RedmineServiceException

Add a new time entry to the given issue for the given project and return the updated time entry.

b>Note: This method requires to be loggued on redmine server.

Parameters:

projectName - the name of the project

issueId - the id of the issue to update

entry - time entry to add

Returns:

the created time entry

Throws:

RedmineServiceException - if any pb while sending or retrieving datas to redmine server

Since:

1.0.3

See Also:

Issue, TimeEntry