jwma Development - Contacts Documentation
Main | Deployment | Configuration | Architecture | Development | Screenshots | SF Project Site
Index | Overview | Building | API Docs | Credits & Contributors

Introduction

This document describes the architecture of the contacts part of the model, and specifies the data which is associated to contacts and contact groups.
The contacts model is based on three levels, two of which are pure interfaces, modeling view and controller/model based access respectively. The actual implementations are supposed to be provided with the contact management plugin. Figure 1 presents a class diagram with an overview of the preferences part of the model.

Figure 1: Contacts Model Overview

See the API documentation for more details:

• JwmaContacts
• JwmaContactsImpl
• JwmaContact
• JwmaContactImpl
• JwmaContactGroup
• JwmaContactGroupImpl

The following two sections describe the data stored in contacts and contact groups. The identifier in the last column is supposed to be used throughout the project (e.g. HTML form field names, XML tag identifiers, variable names), to allow rapid recognition and association.


Contact Data

Data field (cn)	Description	Identifier
UID*	The unique identifier of the contact.	uid
Category	The category of the contact.	category
Nickname	The nickname of the contact.	nickname
Firstname	The firstname(s) of the contact.	firstname
Lastname	The lastname(s) of the contact.	lastname
Middlename	The middlename(s) of the contact.	middlename
Company	The company of the contact, if applicable.	company
Title	The title of the contact, if applicable.	title
Role	The role of the contact, if applicable	role
Home Phone	The phone number associated with the residence of the contact.	phone.home
Work Phone	The phone number associated with the working place of the contact.	phone.work
Pager Number	The phone number associated with the pager of the contact.	phone.pager
Fax Number	A phone number associated with a fax related to the contact.	phone.fax
Mobile Number	The phone number associated with the mobile phone of the contact.	phone.mobile
Primary Location	Flags if the contact is primary a work or personal contact.	primary.location
Work Street	The street part of the work address.	work.street
Work City	The city part of the work address.	work.city
Work Region	The region part of the work address.	work.region
Work Country	The country part of the work address.	work.country
Work Zip	The zip part of the work address.	work.zip
Home Street	The street part of the home address.	home.street
Home City	The city part of the home address.	home.city
Home Region	The region part of the home address.	home.region
Home Country	The country part of the home address.	home.country
Home Zip	The zip part of the home address.	home.zip
Primary Email	The primary email address of the contact.	email.primary
Alternate Email	An alternate email address of the contact.	email.alternate
Personal URL	A personal URL associated with the contact.	personal.url
Company URL	An URL associated with the company of the contact if applicable.	company.url
Birthdate	The birthdate of the contact.	birthdate
Comments	Comments about the contact.	comments
Frequent	Flag that determines if this a frequent contact.	frequent

Contact Group Data

Data field (cn)	Description	Identifier
UID*	The unique identifier of the contact group.	group.uid
Name	The name of the group.	group.name
Comments	Comments about the contact group.	group.comments

Note that groups do not necessarily store more then a reference to a member contact.

© 2000-2003 jwma team