Skip navigation links

waggle.common.modules.distlist
Interface XDistributionListModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XDistributionListModule

public static interface XDistributionListModule.Server

extends XAPIInterface.Server

Server interface for the Distribution List Module API.

Nested Class Summary

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

XAPIInterface.Client, XAPIInterface.Server

Method Summary

void	changeListMembers(XObjectID listID, List<XDistributionListChangeInfo> changeInfos) Change a Distribution List members.
XDistributionListInfo	createList(String name, List<XDistributionListChangeInfo> changeInfos) Create a new Distribution List with an initial set of members.
List<XDistributionListSearchInfo>	findDistributionListWithLimit(String searchString, int maxLists) Search for Distribution Lists.
XDistributionListInfo	getList(XObjectID listID) The the Members of a Distribution List.
List<XDistributionListInfo>	getLists() Get all existing Distribution Lists.
void	removeList(XObjectID listID) Remove a Distribution List.
void	renameList(XObjectID listID, String name) Rename a Distribution List.
void	updateList(XObjectID listID, XDistributionListUpdateInfo updateInfo) Update a Distribution List.

Method Detail

getLists

List<XDistributionListInfo> getLists()

Get all existing Distribution Lists.

Returns:

All Distribution Lists information.

getList

XDistributionListInfo getList(XObjectID listID)

The the Members of a Distribution List.

Parameters:

listID - The List.

Returns:

The List info.

createList

XDistributionListInfo createList(String name,
                                 List<XDistributionListChangeInfo> changeInfos)

Create a new Distribution List with an initial set of members.

Parameters:

name - The name of the Distribution List.

changeInfos - The change requests. May be null.

Returns:

The List info.

removeList

void removeList(XObjectID listID)

Remove a Distribution List.

Parameters:

listID - The List.

renameList

void renameList(XObjectID listID,
                String name)

Rename a Distribution List.

Parameters:

listID - The List.

name - The new name of the Distribution List.

changeListMembers

void changeListMembers(XObjectID listID,
                       List<XDistributionListChangeInfo> changeInfos)

Change a Distribution List members.

Parameters:

listID - The List.

changeInfos - The change requests.

updateList

void updateList(XObjectID listID,
                XDistributionListUpdateInfo updateInfo)

Update a Distribution List.

Parameters:

listID - The List.

updateInfo - The change requests.

findDistributionListWithLimit

List<XDistributionListSearchInfo> findDistributionListWithLimit(String searchString,
                                                                int maxLists)

Search for Distribution Lists.

Parameters:

searchString - Search string prefix.

maxLists - max number returned.

Returns:

Found distribution lists.

Skip navigation links