Skip navigation links

waggle.common.modules.contact
Interface XContactModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XContactModule

public static interface XContactModule.Server

extends XAPIInterface.Server

Server interface for the Contact Module API.

Nested Class Summary

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

XAPIInterface.Client, XAPIInterface.Server

Method Summary

XContactInfo	addContact(XContactAddInfo addInfo) Add a new Contact.
void	addContactToGroup(XObjectID userID, String groupName) Add a Contact to a Group.
void	addGroup(String groupName) Add a Group.
XContactsInfo	getContacts() Get all existing Contacts.
void	moveContactToGroup(XObjectID userID, String oldGroupName, String newGroupName) Move a Contact from one group to another.
void	removeContact(XObjectID userID) Remove a Contact.
void	removeContactFromGroup(XObjectID userID, String groupName) Remove a Contact from a Group.
void	removeGroup(String groupName) Remove a Group.
void	renameGroup(String oldGroupName, String newGroupName) Rename an existing Group.

Method Detail

getContacts

XContactsInfo getContacts()

Get all existing Contacts.

Returns:

An XContactsInfo containing all existing Contacts and group names.

addContact

XContactInfo addContact(XContactAddInfo addInfo)

Add a new Contact.

Parameters:

addInfo - The User to add. Must NOT be an existing Contact.

Returns:

The User Contact info.

removeContact

void removeContact(XObjectID userID)

Remove a Contact.

Parameters:

userID - The User to remove. Must already be a Contact.

addGroup

void addGroup(String groupName)

Add a Group.

Parameters:

groupName - The Group's name. Must not exist.

renameGroup

void renameGroup(String oldGroupName,
                 String newGroupName)

Rename an existing Group.

Parameters:

oldGroupName - The old Group name. Must already exist.

newGroupName - The new Group name. Must not exist.

removeGroup

void removeGroup(String groupName)

Remove a Group.

Parameters:

groupName - The Group's name. Must already exist.

addContactToGroup

void addContactToGroup(XObjectID userID,
                       String groupName)

Add a Contact to a Group.

Parameters:

userID - The Contact. Must already be a Contact.

groupName - The Group name. Must exist.

moveContactToGroup

void moveContactToGroup(XObjectID userID,
                        String oldGroupName,
                        String newGroupName)

Move a Contact from one group to another.

Parameters:

userID - The Contact. Must already be a Contact.

oldGroupName - The old Group name. Must exist.

newGroupName - The new Group name. Must exist.

removeContactFromGroup

void removeContactFromGroup(XObjectID userID,
                            String groupName)

Remove a Contact from a Group.

Parameters:

userID - The Contact. Must already be a Contact.

groupName - The Group name. Must exist.

Skip navigation links