com.veeva.vault.sdk.api.group

Interface GetGroupsResponse

public interface GetGroupsResponse

Provides methods to retrieve Groups. GroupService.getGroupsByNames(List) and GroupService.getGroupsbyIds(List) return this object.

Method Summary

Modifier and Type	Method and Description
Group	getGroupById(String groupId) Retrieve a Group object for the given Group ID.
Group	getGroupByName(String groupName) Retrieve a Group object for the given Group name.

Method Detail

getGroupByName

Group getGroupByName(String groupName)

Retrieve a Group object for the given Group name.

Parameters:

groupName - name of the Group to retrieve. Cannot be null.

Returns:

Group object, or null if the given group name is not present in the List of group names in the call to GroupService.getGroupsByNames(List) or the given group name is invalid

getGroupById

Group getGroupById(String groupId)

Retrieve a Group object for the given Group ID.

Parameters:

groupId - id of the Group to retrieve. Cannot be null.

Returns:

Group object, or null if the given Group ID is not present in the List of Group IDs in the call to GroupService.getGroupsbyIds(List) or the given Group ID is invalid