com.polarion.alm.ws.client.projects

Interface ProjectWebService

All Superinterfaces:

java.rmi.Remote

public interface ProjectWebService
extends java.rmi.Remote

Method Summary

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

Method Detail

createUser

User createUser(java.lang.String in0)
         throws java.rmi.RemoteException

Create a user.

Parameters:

in0 - loginName the login of the user for creation.

Throws:

java.rmi.RemoteException

Since:

3.2.3

getContainedGroups

ProjectGroup[] getContainedGroups(java.lang.String projectGroupURI)
                           throws java.rmi.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:

java.rmi.RemoteException

Since:

3.3

getContainedProjects

Project[] getContainedProjects(java.lang.String projectGroupURI)
                        throws java.rmi.RemoteException

Gets all projects located directly below a project group.

Parameters:

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

Throws:

java.rmi.RemoteException

Since:

3.3

getDeepContainedProjects

Project[] getDeepContainedProjects(java.lang.String projectGroupURI)
                            throws java.rmi.RemoteException

Gets all projects located below a project group.

Parameters:

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

Throws:

java.rmi.RemoteException

getProject

Project getProject(java.lang.String projectID)
            throws java.rmi.RemoteException

Gets a project.

Parameters:

projectID - the ID of the project to get.

Throws:

java.rmi.RemoteException

getProjectAtLocation

Project getProjectAtLocation(java.lang.String location)
                      throws java.rmi.RemoteException

Gets a project at given location.

Parameters:

location - repository location

Throws:

java.rmi.RemoteException

Since:

3.3

getProjectByURI

Project getProjectByURI(java.lang.String projectURI)
                 throws java.rmi.RemoteException

Gets a project.

Parameters:

projectURI - the URI of the project to get.

Throws:

java.rmi.RemoteException

Since:

3.3

getProjectGroup

ProjectGroup getProjectGroup(java.lang.String projectGroupURI)
                      throws java.rmi.RemoteException

Gets a project group.

Parameters:

projectGroupURI - the URI of the project group to get.

Throws:

java.rmi.RemoteException

getProjectGroupAtLocation

ProjectGroup getProjectGroupAtLocation(java.lang.String location)
                                throws java.rmi.RemoteException

Gets a project group at given location.

Parameters:

location - repository location

Throws:

java.rmi.RemoteException

Since:

3.3

getProjectUsers

User[] getProjectUsers(java.lang.String projectID)
                throws java.rmi.RemoteException

Gets users of a project.

Parameters:

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

Throws:

java.rmi.RemoteException

getRootProjectGroup

ProjectGroup getRootProjectGroup()
                          throws java.rmi.RemoteException

Gets the root project group.

Throws:

java.rmi.RemoteException

getUser

User getUser(java.lang.String userID)
      throws java.rmi.RemoteException

Gets a user.

Parameters:

userID - the ID of the user to get.

Throws:

java.rmi.RemoteException

getUserAvatarURL

java.lang.String getUserAvatarURL(java.lang.String userURI)
                           throws java.rmi.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:

java.rmi.RemoteException

Since:

3.6.0

getUserByUri

User getUserByUri(java.lang.String userURI)
           throws java.rmi.RemoteException

Gets an user.

Parameters:

userURI - user's URI.

Throws:

java.rmi.RemoteException

Since:

3.3

getUsers

User[] getUsers()
         throws java.rmi.RemoteException

Gets all users.

Throws:

java.rmi.RemoteException

Since:

3.3

updateUser

void updateUser(User in0)
         throws java.rmi.RemoteException

Update a user.

Parameters:

in0 - user the user for update.

Throws:

java.rmi.RemoteException

Since:

3.2.3