Package com.polarion.alm.ws.client.projects

Interface ProjectWebService

All Superinterfaces:

Remote

public interface ProjectWebService
extends Remote

Method Summary

Modifier and Type	Method	Description
User	createUser(String in0)	Create a user.
ProjectGroup[]	getContainedGroups(String projectGroupURI)	Gets all project groups located directly below a project group.
Project[]	getContainedProjects(String projectGroupURI)	Gets all projects located directly below a project group.
Project[]	getDeepContainedProjects(String projectGroupURI)	Gets all projects located below a project group.
Project	getProject(String projectID)	Gets a project.
Project	getProjectAtLocation(String location)	Gets a project at given location.
Project	getProjectByURI(String projectURI)	Gets a project.
ProjectGroup	getProjectGroup(String projectGroupURI)	Gets a project group.
ProjectGroup	getProjectGroupAtLocation(String location)	Gets a project group at given location.
User[]	getProjectUsers(String projectID)	Gets users of a project.
ProjectGroup	getRootProjectGroup()	Gets the root project group.
User	getUser(String userID)	Gets a user.
String	getUserAvatarURL(String userURI)	Gets a user Avatar URL.
User	getUserByUri(String userURI)	Gets an user.
User[]	getUsers()	Gets all users.
void	updateUser(User in0)	Update a user.

Method Details

createUser

User createUser(String in0)
         throws RemoteException

Create a user.

Parameters:

in0 - loginName the login of the user for creation.

Throws:

RemoteException

Since:

3.2.3

getContainedGroups

ProjectGroup[] getContainedGroups(String projectGroupURI)
                           throws RemoteException

Gets all project groups located directly below a project group.

Parameters:

projectGroupURI - the URI of the project to get all project groups for.

Throws:

RemoteException

Since:

3.3

getContainedProjects

Project[] getContainedProjects(String projectGroupURI)
                        throws RemoteException

Gets all projects located directly below a project group.

Parameters:

projectGroupURI - the URI of the project to get all projects for.

Throws:

RemoteException

Since:

3.3

getDeepContainedProjects

Project[] getDeepContainedProjects(String projectGroupURI)
                            throws RemoteException

Gets all projects located below a project group.

Parameters:

projectGroupURI - the URI of the project to get all projects for.

Throws:

RemoteException

getProject

Project getProject(String projectID)
            throws RemoteException

Gets a project.

Parameters:

projectID - the ID of the project to get.

Throws:

RemoteException

getProjectAtLocation

Project getProjectAtLocation(String location)
                      throws RemoteException

Gets a project at given location.

Parameters:

location - repository location

Throws:

RemoteException

Since:

3.3

getProjectByURI

Project getProjectByURI(String projectURI)
                 throws RemoteException

Gets a project.

Parameters:

projectURI - the URI of the project to get.

Throws:

RemoteException

Since:

3.3

getProjectGroup

ProjectGroup getProjectGroup(String projectGroupURI)
                      throws RemoteException

Gets a project group.

Parameters:

projectGroupURI - the URI of the project group to get.

Throws:

RemoteException

getProjectGroupAtLocation

ProjectGroup getProjectGroupAtLocation(String location)
                                throws RemoteException

Gets a project group at given location.

Parameters:

location - repository location

Throws:

RemoteException

Since:

3.3

getProjectUsers

User[] getProjectUsers(String projectID)
                throws RemoteException

Gets users of a project.

Parameters:

projectID - the ID of the projects to get the users for.

Throws:

RemoteException

getRootProjectGroup

ProjectGroup getRootProjectGroup()
                          throws RemoteException

Gets the root project group.

Throws:

RemoteException

getUser

User getUser(String userID)
      throws RemoteException

Gets a user.

Parameters:

userID - the ID of the user to get.

Throws:

RemoteException

getUserAvatarURL

String getUserAvatarURL(String userURI)
                 throws RemoteException

Gets a user Avatar URL. It can be absolute, or relative to portal base URL.

Parameters:

userURI - the ID of the user (name of the argument is wrong)

Throws:

RemoteException

Since:

3.6.0

getUserByUri

User getUserByUri(String userURI)
           throws RemoteException

Gets an user.

Parameters:

userURI - user's URI.

Throws:

RemoteException

Since:

3.3

getUsers

User[] getUsers()
         throws RemoteException

Gets all users.

Throws:

RemoteException

Since:

3.3

updateUser

void updateUser(User in0)
         throws RemoteException

Update a user. Please note that some fields in the updated User: watches and votes will not be changed.

Parameters:

in0 - user the user for update.

Throws:

RemoteException

Since:

3.2.3