nl.surfnet.coin.teams.service

Interface GrouperTeamService

All Known Implementing Classes:

GrouperTeamServiceWsImpl, InMemoryMockTeamService

public interface GrouperTeamService

Main interface for dealing with Teams

Method Summary

Methods

Modifier and Type	Method and Description
void	addMember(String teamId, nl.surfnet.coin.api.client.domain.Person person) Adds a person to the team
boolean	addMemberRole(String teamId, String memberId, Role role, String actAsUserId) Add Role to a Team
String	addTeam(String teamId, String displayName, String teamDescription, String stemName) Add a Team.
void	deleteMember(String teamId, String personId) Delete a Member from a Team
void	deleteTeam(String teamId) Delete a Team
Set<Member>	findAdmins(Team team) Returns a Set of Member's that have the admin role for this team
TeamResultWrapper	findAllTeamsByMember(String personId, int offset, int pageSize) Return all teams using a specific stem where the personId is a member
Member	findMember(String teamId, String memberId) Tries to find a Member in a Team
TeamResultWrapper	findPublicTeams(String personId, String partOfGroupname) Return all teams using a specific stem with a name like, , without the teams being private except if the personId is a member of the private team
Stem	findStem(String stemId)
List<Stem>	findStemsByMember(String personId) Return all stems for a person
Team	findTeamById(String teamId) Find Team by id
TeamResultWrapper	findTeamsByMember(String personId, String partOfGroupname, int offset, int pageSize) Return all teams using a specific stem with a name like where the personId is a member
boolean	removeMemberRole(String teamId, String memberId, Role role, String actAsUserId) Remove Role to a Team
void	setVisibilityGroup(String teamId, boolean viewable) Update the Team to be (not) visible
void	updateTeam(String teamId, String displayName, String teamDescription, String actAsSubject) Update a Team

Method Detail

findTeamById

Team findTeamById(String teamId)

Find Team by id

Parameters:

teamId - unique identifier for a Team

Returns:

Team with all members

addTeam

String addTeam(String teamId,
             String displayName,
             String teamDescription,
             String stemName)
               throws DuplicateTeamException

Add a Team. Note that the teamId is altered if not compliant to the rules for correct id's.

Parameters:

teamId - the teamId

displayName - the displayName

teamDescription - description of the team

stemName - name of the stem

Returns:

The id of the team

Throws:

DuplicateTeamException - when a team with with the given teamId already exists.

updateTeam

void updateTeam(String teamId,
              String displayName,
              String teamDescription,
              String actAsSubject)

Update a Team

Parameters:

teamId - the id of a Team

displayName - the new displayName

teamDescription - the new description of the Team

actAsSubject - the unique identifier that performs the request in Grouper. Can be the power user or the memberId

deleteTeam

void deleteTeam(String teamId)

Delete a Team

Parameters:

teamId - the unique identifier

deleteMember

void deleteMember(String teamId,
                String personId)

Delete a Member from a Team

Parameters:

teamId - the unique identifier for a Team

personId - the unique identifier for a Member

setVisibilityGroup

void setVisibilityGroup(String teamId,
                      boolean viewable)

Update the Team to be (not) visible

Parameters:

teamId - unique identifier for a Team

viewable - boolean

addMemberRole

boolean addMemberRole(String teamId,
                    String memberId,
                    Role role,
                    String actAsUserId)

Add Role to a Team

Parameters:

teamId - the unique identifier of a Team

memberId - the unique identifier of a Member

role - the Role to be added

actAsUserId - the unique identifier that performs the request in Grouper. Can be the power user or the memberId

Returns:

boolean true if the Role has been successfully added false if the Role has not been added

removeMemberRole

boolean removeMemberRole(String teamId,
                       String memberId,
                       Role role,
                       String actAsUserId)

Remove Role to a Team

Parameters:

teamId - the unique identifier of a Team

memberId - the unique identifier of a Member

role - the Role to be removed

actAsUserId - the unique identifier that performs the request in Grouper. Can be the power user of the memberId

Returns:

boolean true if the Role has been successfully added false if the Role has not been added

addMember

void addMember(String teamId,
             nl.surfnet.coin.api.client.domain.Person person)

Adds a person to the team

Parameters:

teamId - the unique identifier of the Team

person - Person to add as Member to the Team

findMember

Member findMember(String teamId,
                String memberId)

Tries to find a Member in a Team

Parameters:

teamId - the unique identifier of the Team

memberId - the unique identifier of a Member

Returns:

Member or null if the Team does not contain a Member by the memberId

findAdmins

Set<Member> findAdmins(Team team)

Returns a Set of Member's that have the admin role for this team

Parameters:

team - Team

Returns:

Set of Member's with admin role, can be empty

findStem

Stem findStem(String stemId)

findPublicTeams

TeamResultWrapper findPublicTeams(String personId,
                                String partOfGroupname)

Return all teams using a specific stem with a name like, , without the teams being private except if the personId is a member of the private team

Parameters:

personId - the logged in person

partOfGroupname - part of group name

Returns:

teams including the number of total records

findAllTeamsByMember

TeamResultWrapper findAllTeamsByMember(String personId,
                                     int offset,
                                     int pageSize)

Return all teams using a specific stem where the personId is a member

Parameters:

personId - the logged in person

offset - the row number of the start

pageSize - the maximum result size

Returns:

teams including the number of total records

findTeamsByMember

TeamResultWrapper findTeamsByMember(String personId,
                                  String partOfGroupname,
                                  int offset,
                                  int pageSize)

Return all teams using a specific stem with a name like where the personId is a member

Parameters:

personId - the logged in person

partOfGroupname - part of group name

offset - the row number of the start

pageSize - the maximum result size

Returns:

teams including the number of total records

findStemsByMember

List<Stem> findStemsByMember(String personId)

Return all stems for a person

Parameters:

personId - String the identifier of the logged in person

Returns:

List the list with stems that this user is a member of.