org.nuiton.jredmine
Interface RedmineAnonymousService

All Known Subinterfaces:

RedmineService

All Known Implementing Classes:

DefaultRedmineAnonymousService, DefaultRedmineService

public interface RedmineAnonymousService

Contract of all redmine operations which do not requires any login to server.

A default implementation is offered in DefaultRedmineAnonymousService.

Created: 2 janv. 2010

Since:

1.0.3

Version:

$Revision: 66 $

Mise a jour: $Date: 2010-01-03 11:49:37 +0100 (dim., 03 janv. 2010) $ par : $Author: tchemit $

Author:

Tony Chemit Copyright Code Lutin

See Also:

DefaultRedmineAnonymousService

Method Summary

Attachment[]	getAttachments(java.lang.String projectName, java.lang.String versionName) Obtain all attachments for a specific version on a given project
Issue[]	getClosedIssues(java.lang.String projectName) Obtain all closed issues for 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) Obtain all issues for a given project
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.
TimeEntry[]	getIssueTimeEntries(java.lang.String projectName, java.lang.String issueId) Obtain for a given issue of a given project all the time entries.
News[]	getNews(java.lang.String projectName) Obtain all news defined on a given project.
Issue[]	getOpenedIssues(java.lang.String projectName) Obtain all opened issues for a given project
Project	getProject(java.lang.String projectName) Obtain a project given his name.
User[]	getProjectMembers(java.lang.String projectName) Obtain all users defined on a given project.
Project[]	getProjects() Obtain all accessible projets.
Tracker[]	getTrackers(java.lang.String projectName) Obtain all trackers defined on a given project.
User[]	getUsers(java.lang.String projectName) Deprecated. since 1.0.3, use now getProjectMembers(String).
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.

Method Detail

getProjects

Project[] getProjects()
                      throws RedmineServiceException

Obtain all accessible projets.

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

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

Deprecated. since 1.0.3, use now getProjectMembers(String).

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

getProjectMembers

User[] getProjectMembers(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)
                  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(java.lang.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(java.lang.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(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

getIssueTimeEntries

TimeEntry[] getIssueTimeEntries(java.lang.String projectName,
                                java.lang.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(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