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

All Known Implementing Classes:

ProjectServiceImpl

public interface ProjectService

Method Summary

void	archiveVersion(com.atlassian.crowd.embedded.api.User user, java.lang.String projectKey, java.lang.String versionName, boolean archive)
RemoteProject	createProject(com.atlassian.crowd.embedded.api.User user, RemoteProject rProject)
RemoteProject	createProject(com.atlassian.crowd.embedded.api.User user, java.lang.String key, java.lang.String name, java.lang.String description, java.lang.String url, java.lang.String lead, RemotePermissionScheme permissionScheme, RemoteScheme notificationScheme, RemoteScheme issueSecurityScheme)
RemoteVersion	createVersion(com.atlassian.crowd.embedded.api.User user, java.lang.String projectKey, RemoteVersion remoteVersion)
void	deleteProject(com.atlassian.crowd.embedded.api.User user, java.lang.String projectKey)
void	deleteProjectAvatar(com.atlassian.crowd.embedded.api.User user, long avatarId) Deletes the given custom Avatar from the system.
RemoteComponent[]	getComponents(com.atlassian.crowd.embedded.api.User user, java.lang.String projectKey)
RemoteAvatar	getProjectAvatar(com.atlassian.crowd.embedded.api.User user, java.lang.String projectKey, java.lang.String size) Retrieves the current Avatar for the given project.
RemoteAvatar[]	getProjectAvatars(com.atlassian.crowd.embedded.api.User user, java.lang.String projectKey, boolean includeSystemAvatars, java.lang.String size) Retrieves avatars for the given project.
RemoteProject	getProjectById(com.atlassian.crowd.embedded.api.User user, java.lang.Long projectId) Returns the Project with the matching id (if the user has permission to browse it).
RemoteProject	getProjectByKey(com.atlassian.crowd.embedded.api.User user, java.lang.String projectKey) Returns the Project with the matching key (if the user has permission to browse it).
RemoteProject[]	getProjects(com.atlassian.crowd.embedded.api.User user, boolean addSchemes)
RemoteProject	getProjectWithSchemesById(com.atlassian.crowd.embedded.api.User user, java.lang.Long projectId) Returns the project with the matching id (if the user has permission to browse it) with notification, issue security and permission schemes attached.
RemoteSecurityLevel[]	getSecurityLevels(com.atlassian.crowd.embedded.api.User user, java.lang.String projectKey) Return an array of Security Levels for a given project
RemoteVersion[]	getVersions(com.atlassian.crowd.embedded.api.User user, java.lang.String projectKey)
void	releaseVersion(com.atlassian.crowd.embedded.api.User user, java.lang.String projectKey, RemoteVersion remoteVersion)
void	setProjectAvatar(com.atlassian.crowd.embedded.api.User user, java.lang.String projectKey, java.lang.Long avatarId) Sets the current avatar for the given project to that with the given id.
void	setProjectAvatar(com.atlassian.crowd.embedded.api.User user, java.lang.String projectKey, java.lang.String contentType, java.lang.String base64ImageData) Creates a new custom avatar for the given project and sets it to be current for the project.
RemoteProject	updateProject(com.atlassian.crowd.embedded.api.User user, RemoteProject rProject)

Method Detail

getProjects

RemoteProject[] getProjects(com.atlassian.crowd.embedded.api.User user,
                            boolean addSchemes)
                            throws RemoteException

Throws:

RemoteException

getProjectByKey

RemoteProject getProjectByKey(com.atlassian.crowd.embedded.api.User user,
                              java.lang.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(com.atlassian.crowd.embedded.api.User user,
                             java.lang.Long projectId)
                             throws 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.

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

getProjectWithSchemesById

RemoteProject getProjectWithSchemesById(com.atlassian.crowd.embedded.api.User user,
                                        java.lang.Long projectId)
                                        throws RemoteException

Returns the project with the matching id (if the user has permission to browse it) with notification, issue security and permission schemes attached.

Parameters:

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

projectId - 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(com.atlassian.crowd.embedded.api.User user,
                                java.lang.String projectKey)
                                throws RemoteException

Throws:

RemoteException

getVersions

RemoteVersion[] getVersions(com.atlassian.crowd.embedded.api.User user,
                            java.lang.String projectKey)
                            throws RemoteException

Throws:

RemoteException

createProject

RemoteProject createProject(com.atlassian.crowd.embedded.api.User user,
                            java.lang.String key,
                            java.lang.String name,
                            java.lang.String description,
                            java.lang.String url,
                            java.lang.String lead,
                            RemotePermissionScheme permissionScheme,
                            RemoteScheme notificationScheme,
                            RemoteScheme issueSecurityScheme)
                            throws RemoteException

Throws:

RemoteException

createProject

RemoteProject createProject(com.atlassian.crowd.embedded.api.User user,
                            RemoteProject rProject)
                            throws RemoteException

Throws:

RemoteException

updateProject

RemoteProject updateProject(com.atlassian.crowd.embedded.api.User user,
                            RemoteProject rProject)
                            throws RemoteException

Throws:

RemoteException

deleteProject

void deleteProject(com.atlassian.crowd.embedded.api.User user,
                   java.lang.String projectKey)
                   throws RemoteException

Throws:

RemoteException

createVersion

RemoteVersion createVersion(com.atlassian.crowd.embedded.api.User user,
                            java.lang.String projectKey,
                            RemoteVersion remoteVersion)
                            throws RemoteException

Throws:

RemoteException

releaseVersion

void releaseVersion(com.atlassian.crowd.embedded.api.User user,
                    java.lang.String projectKey,
                    RemoteVersion remoteVersion)
                    throws RemoteException

Throws:

RemoteException

archiveVersion

void archiveVersion(com.atlassian.crowd.embedded.api.User user,
                    java.lang.String projectKey,
                    java.lang.String versionName,
                    boolean archive)
                    throws RemoteException

Throws:

RemoteException

getSecurityLevels

RemoteSecurityLevel[] getSecurityLevels(com.atlassian.crowd.embedded.api.User user,
                                        java.lang.String projectKey)
                                        throws RemoteException,
                                               RemotePermissionException

Return an array of Security Levels for a given project

Parameters:

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

projectKey - the key of the requested project

Returns:

array of RemoteSecurityLevel objects for the project. The Array will be empty if the user does not have the Set Security Level permission for the project.

Throws:

RemoteException - If the project key is invalid or the Security Levels could not be retrieved

RemotePermissionException - If the User does not have Browse permission for the project

Since:

v3.13

getProjectAvatars

RemoteAvatar[] getProjectAvatars(com.atlassian.crowd.embedded.api.User user,
                                 java.lang.String projectKey,
                                 boolean includeSystemAvatars,
                                 java.lang.String size)
                                 throws RemoteException,
                                        RemotePermissionException

Retrieves avatars for the given project. If the includeSystemAvatars parameter is true, this will include both system (built-in) avatars as well as custom (user-supplied) avatars for that project, otherwise it will include only the custom avatars.

Parameters:

user - the user whos asking, must have BROWSE permission to the project.

projectKey - the key for the project.

includeSystemAvatars - if false, only custom avatars will be included in the returned array.

size - "large" or "small".

Returns:

the avatars for the project, possibly empty.

Throws:

RemoteException - If the project key is invalid.

RemotePermissionException - If you do not have Browse permission for the project.

Since:

4.0

setProjectAvatar

void setProjectAvatar(com.atlassian.crowd.embedded.api.User user,
                      java.lang.String projectKey,
                      java.lang.String contentType,
                      java.lang.String base64ImageData)
                      throws RemoteException

Creates a new custom avatar for the given project and sets it to be current for the project. The image data must be provided as base64 encoded data and should be 48 pixels square. If the image is larger, the top left 48 pixels are taken, if it is smaller it is upscaled to 48 pixels. The small version of the avatar image (16 pixels) is generated automatically.

Parameters:

user - the user setting the avatar, must have PROJECT ADMIN permission to the project.

projectKey - the key for the project.

contentType - the MIME type of the image provided, e.g. image/gif, image/jpeg, image/png.

base64ImageData - a base 64 encoded image, 48 pixels square.

Throws:

RemoteException - If the project key is invalid.

RemotePermissionException - If you do not have project admin permission for the project.

setProjectAvatar

void setProjectAvatar(com.atlassian.crowd.embedded.api.User user,
                      java.lang.String projectKey,
                      java.lang.Long avatarId)
                      throws RemoteException

Sets the current avatar for the given project to that with the given id.

Parameters:

user - the user setting the avatar, must have PROJECT ADMIN permission to the project.

projectKey - the key for the project.

avatarId - the id of an existing avatar to use for the project or null for the default avatar.

Throws:

RemoteException - If the project key is invalid.

RemotePermissionException - If you do not have project admin permission for the project.

getProjectAvatar

RemoteAvatar getProjectAvatar(com.atlassian.crowd.embedded.api.User user,
                              java.lang.String projectKey,
                              java.lang.String size)
                              throws RemoteException,
                                     RemotePermissionException

Retrieves the current Avatar for the given project.

Parameters:

user - the user whos asking, must have BROWSE permission to the project.

projectKey - the key for the project.

size - "large" or "small".

Returns:

the current avatar for the project.

Throws:

RemoteException - If the project key is invalid.

RemotePermissionException - If you do not have Browse permission for the project.

Since:

4.0

deleteProjectAvatar

void deleteProjectAvatar(com.atlassian.crowd.embedded.api.User user,
                         long avatarId)
                         throws RemoteException

Deletes the given custom Avatar from the system. System avatars cannot be deleted.

Parameters:

user - the user whos asking, must have PROJECT ADMIN permission to the project.

avatarId - id of the custom avatar to delete.

Throws:

RemoteException - if there is no avatar with the given id, or if it is a system avatar.

RemotePermissionException - If you do not have administer permission for the project.

Since:

4.0