de.jakop.lotus.domingo.groupware.map

Class NamesDatabase

java.lang.Object

de.jakop.lotus.domingo.map.BaseDatabase

de.jakop.lotus.domingo.groupware.map.NamesDatabase

All Implemented Interfaces:

AddressBook

public final class NamesDatabase
extends BaseDatabase
implements AddressBook

Interface to public and private name and address book databases.

Author:

Daniel Schwarz

Constructor Summary

Constructors

Constructor and Description
NamesDatabase(DSession session, NotesLocation location) Constructor.
NamesDatabase(String locationUri) Constructor.

Method Summary

Modifier and Type	Method and Description
Iterator	getContacts() Returns an iterator over all contacts in the Address Book.
boolean	isPrivate() Indicates if a database is a Personal Address Book.
boolean	isPublic() Indicates if a database is a Public Address Book.
protected void	registerMappers() Implemented by derived class; must register all mappers.

Methods inherited from class de.jakop.lotus.domingo.map.BaseDatabase

create, getDatabase, getSession, getTitle, map, map, map, register, save

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.jakop.lotus.domingo.groupware.AddressBook

getTitle

Constructor Detail

NamesDatabase

public NamesDatabase(String locationUri)
              throws IOException,
                     DNotesException

Constructor.

Parameters:

locationUri - URI of location of database.

Throws:

IOException - if the location is not a valid notes location

DNotesException - if the database cannot be opened

NamesDatabase

public NamesDatabase(DSession session,
                     NotesLocation location)
              throws DNotesException

Constructor.

Parameters:

session - an existing domingo session

location - location of database.

Throws:

DNotesException - if the uri is invalid or the database cannot be opened

Method Detail

getContacts

public Iterator getContacts()

Returns an iterator over all contacts in the Address Book.

Should return in alphabetical order

Specified by:

getContacts in interface AddressBook

Returns:

iterator over all contacts in the Address Book

See Also:

AddressBook.getContacts()

isPrivate

public boolean isPrivate()

Indicates if a database is a Personal Address Book.

Specified by:

isPrivate in interface AddressBook

Returns:

true if the database is a Personal Address Book, false if the database is not Personal Address Book

See Also:

AddressBook.isPrivate()

isPublic

public boolean isPublic()

Indicates if a database is a Public Address Book.

Specified by:

isPublic in interface AddressBook

Returns:

true if the database is a Public Address Book, false if the database is not Public Address Book

See Also:

AddressBook.isPublic()

registerMappers

protected void registerMappers()
                        throws MapperRegistrationException

Implemented by derived class; must register all mappers.

Specified by:

registerMappers in class BaseDatabase

Throws:

MapperRegistrationException - if an error occurred during registering a mapper

See Also:

BaseDatabase.registerMappers()