Package pl.edu.icm.unity.engine.api.project

Interface DelegatedGroupManagement

public interface DelegatedGroupManagement

Internal engine API for delegated groups management

Author:

P.Piernik

Method Summary

Modifier and Type	Method	Description
String	addGroup(String projectPath, String parentPath, I18nString groupName, boolean isPublic)	Adds group
void	addMemberToGroup(String projectPath, String subgroupPath, long entityId)	Adds a new member to the group
String	getAttributeDisplayedName(String projectPath, String attributeName)	Gets attribute displayed name
DelegatedGroupContents	getContents(String projectPath, String subgroupPath)	Allows to retrieve group's contents and metadata.
List<DelegatedGroupMember>	getDelegatedGroupMembers(String projectPath, String subgroupPath)	Gets delegated group members
Map<String,DelegatedGroupContents>	getGroupAndSubgroups(String projectPath, String subgroupPath)	Gets group with all child (recursive) groups as map.
GroupAuthorizationRole	getGroupAuthorizationRole(String projectPath, long entityId)	Update value of group authorization role attribute
List<DelegatedGroup>	getProjectsForEntity(long entityId)	Gets projects for entity
void	removeGroup(String projectPath, String path)	Removes group
void	removeMemberFromGroup(String projectPath, String subgroupPath, long entityId)	Removes from the group and all subgroups if the user is in any.
void	removeProject(String projectPath, String subProjectPath)	Removes subproject
void	setGroupAccessMode(String projectPath, String path, boolean isPublic)	Updates group access mode
void	setGroupAuthorizationRole(String projectPath, String subgroupPath, long entityId, GroupAuthorizationRole role)	Update value of group authorization role attribute
void	setGroupDelegationConfiguration(String projectPath, String subgroupPath, SubprojectGroupDelegationConfiguration subprojectGroupDelegationConfiguration)	Sets group delegation configuration
void	setGroupDisplayedName(String projectPath, String path, I18nString newName)	Sets group display name

Method Detail

addGroup

String addGroup(String projectPath,
                String parentPath,
                I18nString groupName,
                boolean isPublic)
         throws EngineException

Adds group

Parameters:

projectPath - project group path

parentPath - parent group path

groupName - new group name

isPublic - group access mode

Returns:

Throws:

EngineException

removeGroup

void removeGroup(String projectPath,
                 String path)
          throws EngineException

Removes group

Parameters:

projectPath - project group path

path - removed group path

Throws:

EngineException

removeProject

void removeProject(String projectPath,
                   String subProjectPath)
            throws EngineException

Removes subproject

Parameters:

projectPath - project group path

subProjectPath - removed subproject group path

Throws:

EngineException

getContents

DelegatedGroupContents getContents(String projectPath,
                                   String subgroupPath)
                            throws EngineException

Allows to retrieve group's contents and metadata.

Parameters:

subgroupPath - group to be queried.

Returns:

Throws:

EngineException

setGroupDisplayedName

void setGroupDisplayedName(String projectPath,
                           String path,
                           I18nString newName)
                    throws EngineException

Sets group display name

Parameters:

projectPath - project group path

path - renamed group path

newName -

Throws:

EngineException

setGroupAccessMode

void setGroupAccessMode(String projectPath,
                        String path,
                        boolean isPublic)
                 throws EngineException

Updates group access mode

Parameters:

projectPath - project group path

path - updated group path

isPublic - indicates is group public or private mode

Throws:

EngineException

getGroupAndSubgroups

Map<String,DelegatedGroupContents> getGroupAndSubgroups(String projectPath,
                                                              String subgroupPath)
                                                       throws EngineException

Gets group with all child (recursive) groups as map.

Parameters:

projectPath - is a full path to the project's underlying group

subgroupPath - is a full path to a subgroup of the project of which groups will be received

Returns:

keys of the returned map include the selected group and all its children. Values are objects with group's metadata and subgroups

Throws:

EngineException

getAttributeDisplayedName

String getAttributeDisplayedName(String projectPath,
                                 String attributeName)
                          throws EngineException

Gets attribute displayed name

Parameters:

projectPath - project group path

attributeName -

Returns:

attribute display name

Throws:

EngineException

setGroupAuthorizationRole

void setGroupAuthorizationRole(String projectPath,
                               String subgroupPath,
                               long entityId,
                               GroupAuthorizationRole role)
                        throws EngineException

Update value of group authorization role attribute

Parameters:

projectPath - is a full path to the project's underlying group

subgroupPath - is a full path to a subgroup of the project of which authorization role will be set

entityId - attribute owner

role - value to set

Throws:

EngineException

getGroupAuthorizationRole

GroupAuthorizationRole getGroupAuthorizationRole(String projectPath,
                                                 long entityId)
                                          throws EngineException

Update value of group authorization role attribute

Parameters:

projectPath - project group path

entityId - attribute owner

role - value to set

Throws:

EngineException

setGroupDelegationConfiguration

void setGroupDelegationConfiguration(String projectPath,
                                     String subgroupPath,
                                     SubprojectGroupDelegationConfiguration subprojectGroupDelegationConfiguration)
                              throws EngineException

Sets group delegation configuration

Parameters:

projectPath - is a full path to the project's underlying group

subgroupPath - is a full path to a subgroup of the project of which delegation configuration will be added

subprojectGroupDelegationConfiguration - group delegation configuration to set

Throws:

EngineException

getProjectsForEntity

List<DelegatedGroup> getProjectsForEntity(long entityId)
                                   throws EngineException

Gets projects for entity

Parameters:

entityId - project manager

Returns:

All project group of entity

Throws:

EngineException

addMemberToGroup

void addMemberToGroup(String projectPath,
                      String subgroupPath,
                      long entityId)
               throws EngineException

Adds a new member to the group

Parameters:

projectPath - is a full path to the project's underlying group

subgroupPath - is a full path to a subgroup of the project of which member will be added

entityId - entity id to add

Throws:

EngineException

removeMemberFromGroup

void removeMemberFromGroup(String projectPath,
                           String subgroupPath,
                           long entityId)
                    throws EngineException

Removes from the group and all subgroups if the user is in any. Entity can not be removed from the group == '/'

Parameters:

projectPath - is a full path to the project's underlying group

subgroupPath - is a full path to a subgroup of the project of which member will be removed

entityId - entity id to remove

Throws:

EngineException

getDelegatedGroupMembers

List<DelegatedGroupMember> getDelegatedGroupMembers(String projectPath,
                                                    String subgroupPath)
                                             throws EngineException

Gets delegated group members

Parameters:

projectPath - is a full path to the project's underlying group

subgroupPath - is a full path to a subgroup of the project of which members will be returned

Returns:

Throws:

EngineException