com.taskadapter.redmineapi

Class MembershipManager

java.lang.Object

com.taskadapter.redmineapi.MembershipManager

public class MembershipManager
extends java.lang.Object

Works with User-Project Memberships.

Obtain it via RedmineManager:

 RedmineManager mgr = RedmineManagerFactory.createWithUserAuth(redmineURI, login, password);
 MembershipManager membershipManager = mgr.getMembershipManager();
 

Sample usage:

 roles = mgr.getUserManager().getRoles();
 currentUser = mgr.getUserManager().getCurrentUser();
 final Membership membershipForUser = membershipManager.createMembershipForUser(project.getId(), currentUser.getId(), roles);
 memberships = membershipManager.getMemberships(project.getId());
 membershipManager.delete(membershipForUser);
 

See Also:

RedmineManager

Method Summary

Methods

Modifier and Type	Method and Description
void	createMembershipForGroup(int projectId, int groupId, java.util.Collection<Role> roles) Deprecated.
Membership	createMembershipForUser(int projectId, int userId, java.util.Collection<Role> roles)
void	delete(int membershipId)
void	delete(Membership membership)
Membership	getMembership(int membershipId)
java.util.List<Membership>	getMemberships(int projectId)
java.util.List<Membership>	getMemberships(java.lang.String projectKey)
void	update(Membership membership)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getMemberships

public java.util.List<Membership> getMemberships(java.lang.String projectKey)
                                          throws RedmineException

Throws:

RedmineException

getMemberships

public java.util.List<Membership> getMemberships(int projectId)
                                          throws RedmineException

Throws:

RedmineException

getMembership

public Membership getMembership(int membershipId)
                         throws RedmineException

Throws:

RedmineException

delete

public void delete(int membershipId)
            throws RedmineException

Throws:

RedmineException

delete

public void delete(Membership membership)
            throws RedmineException

Throws:

RedmineException

update

public void update(Membership membership)
            throws RedmineException

Throws:

RedmineException

createMembershipForGroup

@Deprecated
public void createMembershipForGroup(int projectId,
                                       int groupId,
                                       java.util.Collection<Role> roles)
                              throws RedmineException

Deprecated.

THIS DOES NOT WORK YET! fails on Redmine 2.5.2: apparently, it does not support adding group memberships. I submitted bug http://www.redmine.org/issues/17904 This method is here only to show what the future API will look like

Throws:

RedmineException

createMembershipForUser

public Membership createMembershipForUser(int projectId,
                                 int userId,
                                 java.util.Collection<Role> roles)
                                   throws RedmineException

Throws:

RedmineException