org.nuiton.jredmine.service

Interface RedmineAnonymousService

All Known Subinterfaces:

RedmineService

All Known Implementing Classes:

DefaultRedmineService

public interface RedmineAnonymousService

Contract of all redmine operations which do not requires any login to server (if project is public).

Created: 2 janv. 2010

Since:

1.0.3

Author:

tchemit

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Close the service and destroy any connexion to the redmine service.
Attachment[]	getAttachments(String projectName, String versionName) Obtain all attachments for a specific version on a given project.
Issue[]	getClosedIssues(String projectName) Obtain all closed issues for a given project.
IssueCategory[]	getIssueCategories(String projectName) Obtain all categories defined on issues for a given project.
IssuePriority[]	getIssuePriorities() Obtain all the priorities defined on a Issue.
Issue[]	getIssues(String projectName) Obtain all issues for a given project.
Issue[]	getIssues(String projectName, String versionName) Obtain all issues for a specific version on a given project.
IssueStatus[]	getIssueStatuses() Obtain all the statuses defined on a Issue.
TimeEntry[]	getIssueTimeEntries(String projectName, String issueId) Obtain for a given issue of a given project all the time entries.
Version	getLastestClosedVersion(String projectName) Obtain the lastest closed version for a given project.
News[]	getNews(String projectName) Obtain all news defined on a given project.
Issue[]	getOpenedIssues(String projectName) Obtain all opened issues for a given project.
Project	getProject(String projectName) Obtain a project given his name.
User[]	getProjectMembers(String projectName) Obtain all users defined on a given project.
Project[]	getProjects() Obtain all accessible projects.
Tracker[]	getTrackers(String projectName) Obtain all trackers defined on a given project.
Version	getVersion(String projectName, String versionName) Obtain a specific version for a given project.
Version[]	getVersions(String projectName) Obtain all versions defined on a given project.
void	init(RedmineServiceConfiguration configuration) Initialize the service.
boolean	isInit() Tells if service was successful initialized.

Method Detail

init

void init(RedmineServiceConfiguration configuration)
          throws RedmineServiceException

Initialize the service.

Parameters:

configuration - the configuration to be used to init the internal redmine client

Throws:

RedmineServiceException - if any pb

isInit

boolean isInit()

Tells if service was successful initialized.

Returns:

true if service was successfull initialized via method init(RedmineServiceConfiguration), false otherwise.

destroy

void destroy()
             throws RedmineServiceException

Close the service and destroy any connexion to the redmine service.

Throws:

RedmineServiceException - if any pb

getProjects

Project[] getProjects()
                      throws RedmineServiceException

Obtain all accessible projects.

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(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(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(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(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

getProjectMembers

User[] getProjectMembers(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(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(String projectName,
                 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

getLastestClosedVersion

Version getLastestClosedVersion(String projectName)
                                throws RedmineServiceException

Obtain the lastest closed version for a given project.

Parameters:

projectName - the name of the project

Returns:

the version (or null if no version is matching)

Throws:

RedmineServiceException - if any pb while retriving datas

Since:

1.6

See Also:

Version

getIssues

Issue[] getIssues(String projectName)
                  throws RedmineServiceException

Obtain all issues for a given project.

Parameters:

projectName - the name of the project

Returns:

the issues

Throws:

RedmineServiceException - if any pb while retriving datas

Since:

1.0.3

See Also:

Issue

getOpenedIssues

Issue[] getOpenedIssues(String projectName)
                        throws RedmineServiceException

Obtain all opened issues for a given project.

Parameters:

projectName - the name of the project

Returns:

the issues

Throws:

RedmineServiceException - if any pb while retriving datas

Since:

1.0.3

See Also:

Issue

getClosedIssues

Issue[] getClosedIssues(String projectName)
                        throws RedmineServiceException

Obtain all closed issues for a given project.

Parameters:

projectName - the name of the project

Returns:

the issues

Throws:

RedmineServiceException - if any pb while retriving datas

Since:

1.0.3

See Also:

Issue

getIssues

Issue[] getIssues(String projectName,
                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

getIssueTimeEntries

TimeEntry[] getIssueTimeEntries(String projectName,
                              String issueId)
                                throws RedmineServiceException

Obtain for a given issue of a given project all the time entries.

Parameters:

projectName - the name of the project

issueId - the id of the issue

Returns:

the time entries of the issue

Throws:

RedmineServiceException - if any pb while retrieving time entries of the issue

Since:

1.0.3

getAttachments

Attachment[] getAttachments(String projectName,
                          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