au.edu.swin.synergy.plugin.addressbook.event
Class BAddressBookCE

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--au.edu.swin.synergy.kernel.BCommandEvent
              |
              +--au.edu.swin.synergy.plugin.addressbook.event.BAddressBookCE

public class BAddressBookCE

extends BCommandEvent

This implementation of BCommandEvent provides a way for the client to request address book data from the client and server address books

Author:

Matthew Evans

See Also:

Serialized Form

Field Summary

static int	kAddAddress Indicates that the client wishes to add the given address.
static int	kListAddressBook Indicates that the client wishes the address book to be provided.
static int	kRemoveAddress Indicates that the client wishes to remove the given address.
static int	kUpdateAddress Indicates the supplied address needs to be updated or added as necessary

Fields inherited from class au.edu.swin.synergy.kernel.BCommandEvent

connectionID, index, kBroadcast, kClient, kClientDone, kLocal, kServer, kServerDone, networkStatus, serialVersionUID

Fields inherited from class java.util.EventObject

source

Constructor Summary

BAddressBookCE(Object source, int requestType, BCommandComplete complete)
Create a user request object with the given request type

Method Summary

BAddress	getAddress() Supplies the address associated with this request
int	getAddressBookOrigin()
Vector	getAddressList() Supplies the addressBook (associated with kListAddressBook)
BAddress	getModifyAddress() Supplies the modifyAddress associated with the kUpdateRequest type.
int	getRequest() Indicates the type of request this is
void	setAddress(BAddress address) Sets the address to operate on
void	setAddressBookOrigin(int origin) Set the address book origin (client or server)
void	setAddressList(Vector addressList) Sets the addressBook (associated with kListAddressBook)
void	setModifyAddress(BAddress modifyAddress) Set's the modifyAddress associated with the kUpdateRequest type.

Methods inherited from class au.edu.swin.synergy.kernel.BCommandEvent

decrementThreadCount, doComplete, doInit, getAutoComplete, getCompletionObject, getCompletionStatus, getConnectionID, getIndex, getNetworkStatus, getPipe, getUndoable, setAutoComplete, setCompletionObject, setCompletionStatus, setConnectionID, setIndex, setNetworkStatus, setPipe, setThreadCount, setUndoable

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

kListAddressBook

public static final int kListAddressBook

Indicates that the client wishes the address book to be provided.

kAddAddress

public static final int kAddAddress

Indicates that the client wishes to add the given address.

kRemoveAddress

public static final int kRemoveAddress

Indicates that the client wishes to remove the given address.

kUpdateAddress

public static final int kUpdateAddress

Indicates the supplied address needs to be updated or added as necessary

Constructor Detail

BAddressBookCE

public BAddressBookCE(Object source,
                      int requestType,
                      BCommandComplete complete)

Create a user request object with the given request type

Parameters:

requestType - The type of request being made

Method Detail

getRequest

public int getRequest()

Indicates the type of request this is

Returns:

The request type

setAddress

public void setAddress(BAddress address)

Sets the address to operate on

getAddress

public BAddress getAddress()

Supplies the address associated with this request

Returns:

The address associated with this request

setModifyAddress

public void setModifyAddress(BAddress modifyAddress)

Set's the modifyAddress associated with the kUpdateRequest type.

Parameters:

The - address associated with this request

getModifyAddress

public BAddress getModifyAddress()

Supplies the modifyAddress associated with the kUpdateRequest type.

Returns:

The address to modify.

setAddressList

public void setAddressList(Vector addressList)

Sets the addressBook (associated with kListAddressBook)

Parameters:

addressBook - the releveant address book

getAddressList

public Vector getAddressList()

Supplies the addressBook (associated with kListAddressBook)

Returns:

an address Book provided by a BAddressBookMgr instance

setAddressBookOrigin

public void setAddressBookOrigin(int origin)

Set the address book origin (client or server)

Parameters:

origin - the origin of the address book that handled this event

getAddressBookOrigin

public int getAddressBookOrigin()

Returns:

the origin of the address book that handled this event (client or server)