au.edu.swin.synergy.plugin.addressbook
Class BAddressBookMgr

java.lang.Object
  |
  +--au.edu.swin.synergy.kernel.BPlugin
        |
        +--au.edu.swin.synergy.plugin.addressbook.BAddressBookMgr

public class BAddressBookMgr

extends BPlugin

Represents the manager of an address book on the client or the server. BAddressBookMgr receives requests to process address book related reuests (save address, update address, get address book, delete address), and subsequently completes the necessary task.

Author:

Matthew Evans

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

kernel

Constructor Summary

BAddressBookMgr()

Method Summary

Vector	doGetAddressBook() Returns the addressBook
String	doGetFileName() Gets the name of the file to save the BAddressBook object to.
int	getAddressBookLocation() A check to determine if this is the server address book manager or the client.
void	onBCommandEvent(Object source, BCommandEvent event) When any data is sent across from a client, this method is called to determine whether it is a request for Address Book data.
void	registerHelp() Register out help with the help system.
void	setup(BStringList params) Creates the manager and initialises the address database

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

dispatchEvent, dispatchEventAndWait, dispatchEventServer, dispatchEventServerAndWait, dispatchEventTo, dispatchEventToAndWait, getDependancies, getKernel, setKernel, setup, unload

Methods inherited from class java.lang.Object

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

Constructor Detail

BAddressBookMgr

public BAddressBookMgr()

Method Detail

setup

public void setup(BStringList params)

Creates the manager and initialises the address database

Overrides:

setup in class BPlugin

onBCommandEvent

public void onBCommandEvent(Object source,
                            BCommandEvent event)

When any data is sent across from a client, this method is called to determine whether it is a request for Address Book data.

Parameters:

source - The origin of the event

event - The event delegated

Overrides:

onBCommandEvent in class BPlugin

registerHelp

public void registerHelp()

Register out help with the help system.

doGetAddressBook

public Vector doGetAddressBook()

Returns the addressBook

Returns:

A Vector of BAddress objects

getAddressBookLocation

public int getAddressBookLocation()

A check to determine if this is the server address book manager or the client.

Returns:

an int representing this as the server address book or the client

doGetFileName

public String doGetFileName()

Gets the name of the file to save the BAddressBook object to.

Returns:

The file name to save the BAddress object to.