Skip navigation links

waggle.common.modules.group
Interface XGroupModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XGroupModule

public static interface XGroupModule.Server

extends XAPIInterface.Server

Server interface for the Group Module API.

Nested Class Summary

Nested classes/interfaces inherited from interface waggle.core.api.XAPIInterface

XAPIInterface.Client, XAPIInterface.Server

Method Summary

void	changeGroupMembers(XObjectID groupID, List<XGroupMemberChangeInfo> changeInfos) Change the direct membership of a Group.
XGroupInfo	createGroup(String name) Create a Group in the internal Realm.
XGroupInfo	createGroupWithMembers(String name, List<XGroupMemberChangeInfo> changeInfos) Create a Group in the internal Realm with an initial set of members.
void	deleteGroup(XObjectID groupID) Delete a Group.
List<XGroupInfo>	findGroups(String searchString) Find Groups.
List<XGroupSearchInfo>	findGroupsWithLimit(String searchString, int maxGroups, boolean searchRealms) Search for a set of Groups including those registered in the database realm and those who are available through one of the other defined realms.
List<XUserInfo>	getAllGroupUsers(XObjectID groupID) Get a flattened list of all DIRECT and IN-DIRECT members of this Group.
List<XConversationInfo>	getAllParentConversations(XObjectID groupID) Get all Conversations that the specified Group is a DIRECT or IN-DIRECT member of.
List<XGroupInfo>	getAllParentGroups(XObjectID groupID) Get all Groups that the specified Group is a DIRECT or IN-DIRECT member of.
XGroupInfo	getGroup(XObjectID groupID) Get a Group.
XGroupDetailsInfo	getGroupDetails(XObjectID groupID) Get a Group's extended information.
List<waggle.common.modules.object.infos.XObjectInfo>	getGroupMembers(XObjectID groupID) Get the list of all DIRECT members of the Group.
List<XGroupInfo>	getGroups(List<XObjectID> groupIDs) Get some Groups.
List<XGroupInfo>	getManagedGroups() Get all internal Groups that the current User manages.
void	setGroupName(XObjectID groupID, String name) Change a Group's name.
void	updateGroup(XObjectID groupID, XGroupUpdateInfo updateInfo) Update a Group's attributes.

Method Detail

createGroup

XGroupInfo createGroup(String name)

Create a Group in the internal Realm.

Parameters:

name - The name.

Returns:

The created internal Group.

createGroupWithMembers

XGroupInfo createGroupWithMembers(String name,
                                  List<XGroupMemberChangeInfo> changeInfos)

Create a Group in the internal Realm with an initial set of members.

Parameters:

name - The name.

changeInfos - The member requests.

Returns:

The created internal Group.

getGroup

XGroupInfo getGroup(XObjectID groupID)

Get a Group.

Parameters:

groupID - The Group.

Returns:

The Group information DTO.

getGroupDetails

XGroupDetailsInfo getGroupDetails(XObjectID groupID)

Get a Group's extended information.

Parameters:

groupID - The Group.

Returns:

The Group's extended information DTO.

getGroups

List<XGroupInfo> getGroups(List<XObjectID> groupIDs)

Get some Groups.

Parameters:

groupIDs - The Groups.

Returns:

The Group information DTOs.

getManagedGroups

List<XGroupInfo> getManagedGroups()

Get all internal Groups that the current User manages.

Returns:

Returns all internal Groups that the current User manages.

findGroups

List<XGroupInfo> findGroups(String searchString)

Find Groups.

Only registered Groups are returned for all Realms.

Requires Admin privilege.

Parameters:

searchString - The Group search String. The percent character (%) matches any number of character(s), including the absence of characters, the underscore character (_) matches a single character. A backslash character can be used to escape these wildcard characters. Note that you must use two backslashes to insert a single backslash into the string.

Returns:

The Groups.

findGroupsWithLimit

List<XGroupSearchInfo> findGroupsWithLimit(String searchString,
                                           int maxGroups,
                                           boolean searchRealms)

Search for a set of Groups including those registered in the database realm and those who are available through one of the other defined realms.

Parameters:

searchString - A search string used to find Groups. No need to include wildcards, as the underlying implementation will return the largest set of groups it reasonably can (given implementation-dependent constraints, such as which fields are indexed for efficient searching).

maxGroups - The maximum number of groups to return.

searchRealms - True to search Realms. False to just search database. If false only registered Groups are returned for all Realms. If true any matching external Realm (LDAP) Groups are also returned.

Returns:

The located set of Group infos.

changeGroupMembers

void changeGroupMembers(XObjectID groupID,
                        List<XGroupMemberChangeInfo> changeInfos)

Change the direct membership of a Group.

Parameters:

groupID - The Group.

changeInfos - The member change requests.

setGroupName

void setGroupName(XObjectID groupID,
                  String name)

Change a Group's name.

Parameters:

groupID - The Group.

name - The new name.

updateGroup

void updateGroup(XObjectID groupID,
                 XGroupUpdateInfo updateInfo)

Update a Group's attributes.

Parameters:

groupID - The Group.

updateInfo - The change requests.

getGroupMembers

List<waggle.common.modules.object.infos.XObjectInfo> getGroupMembers(XObjectID groupID)

Get the list of all DIRECT members of the Group.

Parameters:

groupID - The Group.

Returns:

The direct members of the Group.

getAllGroupUsers

List<XUserInfo> getAllGroupUsers(XObjectID groupID)

Get a flattened list of all DIRECT and IN-DIRECT members of this Group.

Parameters:

groupID - The Group.

Returns:

All direct and in-direct members of this Group.

deleteGroup

void deleteGroup(XObjectID groupID)

Delete a Group.

Parameters:

groupID - The Group.

getAllParentGroups

List<XGroupInfo> getAllParentGroups(XObjectID groupID)

Get all Groups that the specified Group is a DIRECT or IN-DIRECT member of.

Parameters:

groupID - The Group.

Returns:

the Groups that the specified Group is a DIRECT or IN-DIRECT member of including the specified Group.

getAllParentConversations

List<XConversationInfo> getAllParentConversations(XObjectID groupID)

Get all Conversations that the specified Group is a DIRECT or IN-DIRECT member of.

Parameters:

groupID - The Group.

Returns:

The Conversations that the specified Group is a DIRECT or IN-DIRECT member of.

Skip navigation links