nl.surfnet.coin.api.service

Interface GroupService

All Known Implementing Classes:

GroupServiceImpl, MockGroupServiceImpl, MockServiceImpl

public interface GroupService

GroupService responsible for retrieving groups

Method Summary

Methods

Modifier and Type	Method and Description
GroupEntry	getGroup(String userId, String groupId, String onBehalfOf) Get specific Group
Group20Entry	getGroup20(String userId, String groupId, String onBehalfOf) Get specific Group
GroupEntry	getGroups(String userId, String onBehalfOf, Integer count, Integer startIndex, String sortBy) Get Persons' Groups
Group20Entry	getGroups20(String userId, String onBehalfOf, Integer count, Integer startIndex, String sortBy) Get Persons' Groups
Group20Entry	getGroups20ByIds(String personId, String[] ids, Integer count, Integer startIndex) Get a list of Group20's by the given list of group ids

Method Detail

getGroups

@PreAuthorize(value="#onBehalfOf == null or #userId.equals(#onBehalfOf)")
GroupEntry getGroups(String userId,
                                String onBehalfOf,
                                Integer count,
                                Integer startIndex,
                                String sortBy)

Get Persons' Groups

Parameters:

userId - the unique identifier

onBehalfOf - the unique identifier of the user that is going to make the request

count - nr of records to return

startIndex - first record of result set

sortBy - field to sort by

Returns:

List containing the Groups

getGroups20

@PreAuthorize(value="#onBehalfOf == null or #userId.equals(#onBehalfOf)")
Group20Entry getGroups20(String userId,
                                    String onBehalfOf,
                                    Integer count,
                                    Integer startIndex,
                                    String sortBy)

Get Persons' Groups

Parameters:

userId - the unique identifier

onBehalfOf - the unique identifier of the user that is going to make the request

count - nr of records to return

startIndex - first record of result set

sortBy - field to sort by

Returns:

List containing the Groups

getGroup

@PreAuthorize(value="#onBehalfOf == null or #userId.equals(#onBehalfOf)")
GroupEntry getGroup(String userId,
                               String groupId,
                               String onBehalfOf)

Get specific Group

Parameters:

userId - the unique identifier

groupId - the unique identifier

onBehalfOf - the unique identifier of the user that is going to make the request

getGroup20

@PreAuthorize(value="#onBehalfOf == null or #userId.equals(#onBehalfOf)")
Group20Entry getGroup20(String userId,
                                   String groupId,
                                   String onBehalfOf)

Get specific Group

Parameters:

userId - the unique identifier

groupId - the unique identifier

onBehalfOf - the unique identifier of the user that is going to make the request

getGroups20ByIds

Group20Entry getGroups20ByIds(String personId,
                            String[] ids,
                            Integer count,
                            Integer startIndex)

Get a list of Group20's by the given list of group ids

Parameters:

personId - the personId

ids - the array of ids

count - nr of records to return

startIndex - first record of result set

Returns:

the list of groups.