com.atlassian.jira.rpc.soap.service
Interface ProjectService

All Known Implementing Classes:

ProjectServiceImpl

public interface ProjectService

Method Summary

void	archiveVersion(User user, String projectKey, String versionName, boolean archive)
RemoteProject	createProject(User user, RemoteProject rProject)
RemoteProject	createProject(User user, String key, String name, String description, String url, String lead, RemotePermissionScheme permissionScheme, RemoteScheme notificationScheme, RemoteScheme issueSecurityScheme)
RemoteVersion	createVersion(User user, String projectKey, RemoteVersion remoteVersion)
void	deleteProject(User user, String projectKey)
RemoteComponent[]	getComponents(User user, String projectKey)
RemoteProject	getProjectById(User user, Long id) Returns the Project with the matching id (if the user has permission to browse it).
RemoteProject	getProjectByKey(User user, String projectKey) Returns the Project with the matching key (if the user has permission to browse it).
RemoteProject[]	getProjects(User user, boolean addSchemes)
RemoteVersion[]	getVersions(User user, String projectKey)
void	releaseVersion(User user, String projectKey, RemoteVersion remoteVersion)
RemoteProject	updateProject(User user, RemoteProject rProject)

Method Detail

getProjects

RemoteProject[] getProjects(User user,
                            boolean addSchemes)
                            throws RemoteException

Throws:

RemoteException

getProjectByKey

RemoteProject getProjectByKey(User user,
                              String projectKey)
                              throws RemotePermissionException,
                                     RemoteException

Returns the Project with the matching key (if the user has permission to browse it).

Parameters:

user - the authenticated User attempting to access the project. Permission checks are run against them.

projectKey - the key of the requested after project

Returns:

the Project object specified by the key, if it exists and the user has the BROWSE permission for it

Throws:

RemotePermissionException - if the User does not have permission to BROWSE the project.

RemoteException

getProjectById

RemoteProject getProjectById(User user,
                             Long id)
                             throws RemotePermissionException,
                                    RemoteException

Returns the Project with the matching id (if the user has permission to browse it).

Parameters:

user - the authenticated User attempting to access the project. Permission checks are run against them.

id - the id of the requested after project

Returns:

the Project object specified by the id, if it exists and the user has the BROWSE permission for it

Throws:

RemotePermissionException - if the User does not have permission to BROWSE the project.

RemoteException

getComponents

RemoteComponent[] getComponents(User user,
                                String projectKey)
                                throws RemotePermissionException,
                                       RemoteException

Throws:

RemotePermissionException

RemoteException

getVersions

RemoteVersion[] getVersions(User user,
                            String projectKey)
                            throws RemotePermissionException,
                                   RemoteException

Throws:

RemotePermissionException

RemoteException

createProject

RemoteProject createProject(User user,
                            String key,
                            String name,
                            String description,
                            String url,
                            String lead,
                            RemotePermissionScheme permissionScheme,
                            RemoteScheme notificationScheme,
                            RemoteScheme issueSecurityScheme)
                            throws RemotePermissionException,
                                   RemoteException,
                                   RemoteValidationException

Throws:

RemotePermissionException

RemoteException

RemoteValidationException

createProject

RemoteProject createProject(User user,
                            RemoteProject rProject)
                            throws RemotePermissionException,
                                   RemoteException,
                                   RemoteValidationException

Throws:

RemotePermissionException

RemoteException

RemoteValidationException

updateProject

RemoteProject updateProject(User user,
                            RemoteProject rProject)
                            throws RemotePermissionException,
                                   RemoteException,
                                   RemoteValidationException

Throws:

RemotePermissionException

RemoteException

RemoteValidationException

deleteProject

void deleteProject(User user,
                   String projectKey)
                   throws RemotePermissionException,
                          RemoteException

Throws:

RemotePermissionException

RemoteException

createVersion

RemoteVersion createVersion(User user,
                            String projectKey,
                            RemoteVersion remoteVersion)
                            throws RemoteException

Throws:

RemoteException

releaseVersion

void releaseVersion(User user,
                    String projectKey,
                    RemoteVersion remoteVersion)
                    throws RemoteException

Throws:

RemoteException

archiveVersion

void archiveVersion(User user,
                    String projectKey,
                    String versionName,
                    boolean archive)
                    throws RemoteException

Throws:

RemoteException