com.atlassian.jira.project
Interface AdminProjectManager

All Known Implementing Classes:

AAdminProjectManager, DefaultAdminProjectManager, OtherDefaultAdminProjectManager

public interface AdminProjectManager

------------------------------------ � Kaamelot - 2006 ------------------------------------

Author:

Kaamelot Projet : Myrddin Fichier : AdminProjectManager.java Description : This Interface defines methods providing informations concerning Users and Groups for the Project Administration

Method Summary

com.opensymphony.user.User	addUserToGroup(java.lang.Long _projectId, java.lang.String _group, java.lang.String _user)
com.opensymphony.user.User	createUser(java.lang.Long _projectId, java.lang.String _userName, java.lang.String _fullName, java.lang.String _email)
java.util.Collection	getAuthorizedGroups(org.ofbiz.core.entity.GenericValue _project, java.util.Map _params)
java.util.Collection	getAuthorizingGroups(org.ofbiz.core.entity.GenericValue _project, com.opensymphony.user.User _user)
java.util.Collection	getCreateUserAuthorizingGroups(org.ofbiz.core.entity.GenericValue _project, com.opensymphony.user.User _user)
com.atlassian.plugin.web.Condition	getDefaultActivationCondition()
java.lang.String	getDefaultActivationConditionFQCN()
java.lang.String	getFilteringGroupName()
java.util.Map	getManageableGroupParameters()
java.util.Collection	getManageableGroups(org.ofbiz.core.entity.GenericValue _project, java.util.Map _params, com.opensymphony.user.User _user)
java.util.Collection	getWorkableGroups(org.ofbiz.core.entity.GenericValue _project)
boolean	isHasManagerPermission(org.ofbiz.core.entity.GenericValue _project, com.opensymphony.user.User _user) Evaluate if the current user can Administer Group for its project
boolean	isHasManagerPermission(java.lang.Long _projectId, com.opensymphony.user.User _user) Evaluate if the current user can Administer Group for its project
boolean	isHasUserCreatePermission(java.lang.Long _projectId, com.opensymphony.user.User _user)
void	removeUserFromGroup(java.lang.Long _projectId, java.lang.String _group, java.lang.String _user)

Method Detail

getDefaultActivationCondition

com.atlassian.plugin.web.Condition getDefaultActivationCondition()

Returns:

The FQCN of Condition to evaluate to use the current AdminProjectManager

getDefaultActivationConditionFQCN

java.lang.String getDefaultActivationConditionFQCN()

Returns:

The FQCN of Condition to evaluate to use the current AdminProjectManager

getAuthorizingGroups

java.util.Collection getAuthorizingGroups(org.ofbiz.core.entity.GenericValue _project,
                                          com.opensymphony.user.User _user)

Parameters:

_project - Concerned Project

_user - Concerned User

Returns:

A list of Rule given the permission to administer the Project

getCreateUserAuthorizingGroups

java.util.Collection getCreateUserAuthorizingGroups(org.ofbiz.core.entity.GenericValue _project,
                                                    com.opensymphony.user.User _user)

Parameters:

_project - Concerned Project

_user - Concerned User

Returns:

A list of Rule given the permission to create User

getManageableGroupParameters

java.util.Map getManageableGroupParameters()

Returns:

Map of Parameters required to identified Manageable Group

getAuthorizedGroups

java.util.Collection getAuthorizedGroups(org.ofbiz.core.entity.GenericValue _project,
                                         java.util.Map _params)

Parameters:

_project - Concerned Project

_params - List of Parameters required to defined the list of Groups

Returns:

List of Groups identified as authorised to access the Project

getWorkableGroups

java.util.Collection getWorkableGroups(org.ofbiz.core.entity.GenericValue _project)

Parameters:

_project - Concerned Project

_params - List of Parameters required to defined the list of Groups

Returns:

List of Groups identified as authorised to Work on the Project

getManageableGroups

java.util.Collection getManageableGroups(org.ofbiz.core.entity.GenericValue _project,
                                         java.util.Map _params,
                                         com.opensymphony.user.User _user)

Parameters:

_project - Concerned Project

_params - List of Parameters required to defined the list of Groups

Returns:

List of Groups identified in Project

isHasManagerPermission

boolean isHasManagerPermission(java.lang.Long _projectId,
                               com.opensymphony.user.User _user)

Evaluate if the current user can Administer Group for its project

Returns:

True, if current has required Permission or Rule

Throws:

java.lang.Exception

isHasManagerPermission

boolean isHasManagerPermission(org.ofbiz.core.entity.GenericValue _project,
                               com.opensymphony.user.User _user)

Evaluate if the current user can Administer Group for its project

Parameters:

_project - Concerned Project

_user - Concerned User

Returns:

True, if current has required Permission or Rule

Throws:

java.lang.Exception

getFilteringGroupName

java.lang.String getFilteringGroupName()

Returns:

The Filtering Group Name used for UserPicker to select User To Add

addUserToGroup

com.opensymphony.user.User addUserToGroup(java.lang.Long _projectId,
                                          java.lang.String _group,
                                          java.lang.String _user)
                                          throws com.opensymphony.user.EntityNotFoundException,
                                                 com.atlassian.jira.exception.PermissionException,
                                                 com.opensymphony.user.DuplicateEntityException

Throws:

com.opensymphony.user.EntityNotFoundException

com.atlassian.jira.exception.PermissionException

com.opensymphony.user.DuplicateEntityException

removeUserFromGroup

void removeUserFromGroup(java.lang.Long _projectId,
                         java.lang.String _group,
                         java.lang.String _user)
                         throws com.opensymphony.user.EntityNotFoundException,
                                com.atlassian.jira.exception.PermissionException

Throws:

com.opensymphony.user.EntityNotFoundException

com.atlassian.jira.exception.PermissionException

isHasUserCreatePermission

boolean isHasUserCreatePermission(java.lang.Long _projectId,
                                  com.opensymphony.user.User _user)

Parameters:

_projectId - Project Id.

_user -

Returns:

createUser

com.opensymphony.user.User createUser(java.lang.Long _projectId,
                                      java.lang.String _userName,
                                      java.lang.String _fullName,
                                      java.lang.String _email)
                                      throws com.atlassian.jira.exception.PermissionException

Parameters:

_projectId - Project Id.

_userName - User Name (Login)

_fullName - Full User Name

_email - email

Throws:

com.atlassian.jira.exception.PermissionException