dtw.webmail.model
Interface JwmaContacts

All Known Subinterfaces:

JwmaContactsImpl

All Known Implementing Classes:

CastorContacts

public interface JwmaContacts

An interface defining the contract for interaction with the JwmaContacts model.

The JwmaContacts allows a view programmer to obtain information about the contact database to display items for reading or editing.

Version:

0.9.7 07/02/2003

Author:

Dieter Wimberger

Method Summary

JwmaContact	getContact(java.lang.String uid) Returns an JwmaContact representing the contact with the given unique identifier.
JwmaContactGroup	getContactGroup(java.lang.String uid) Returns an JwmaContactGroup representing the contact group with the given unique identifier.
java.lang.String	getUID() Returns the unique identifier of this JwmaContacts.
java.lang.String[]	listContactCategories() Returns an array of available contact categories.
JwmaContactGroup[]	listContactGroups() Returns an array of contact groups containing all groups of this contact database.
JwmaContact[]	listContacts() Returns an array of contacts containing all contacts in this contact database.
JwmaContact[]	listFrequentRecipients() Returns an array of contacts containing all frequent recipient contacts.

Method Detail

getUID

public java.lang.String getUID()

Returns the unique identifier of this JwmaContacts.

Returns:

the unique identifier as String.

listContactCategories

public java.lang.String[] listContactCategories()

Returns an array of available contact categories.

Returns:

an array of String's.

listContacts

public JwmaContact[] listContacts()

Returns an array of contacts containing all contacts in this contact database.

If this contact database does not contain any contacts, then this method returns an empty array. Otherwise it contains one JwmaContact for each entry in this contact database.

Returns:

an array of JwmaContact's.

listFrequentRecipients

public JwmaContact[] listFrequentRecipients()

Returns an array of contacts containing all frequent recipient contacts.

If the contact database does not contain any frequent recipient contacts, then this method returns an empty array. Otherwise it contains one JwmaContact for each entry in this contact database.

Returns:

an array of JwmaContact's.

listContactGroups

public JwmaContactGroup[] listContactGroups()

Returns an array of contact groups containing all groups of this contact database.

If this contact database does not contain any groups, then this method returns an empty array. Otherwise it contains one JwmaContactGroup for each group entry in this contact database.

Returns:

an array of JwmaContactGroup's.

getContact

public JwmaContact getContact(java.lang.String uid)

Returns an JwmaContact representing the contact with the given unique identifier.

If the contact database does not contain any contact with the given identifier, it returns null. Otherwise it returns the associated contact.

Returns:

the contact associated with the given identifier, or null.

getContactGroup

public JwmaContactGroup getContactGroup(java.lang.String uid)

Returns an JwmaContactGroup representing the contact group with the given unique identifier.

If the contact database does not contain any contact group with the given identifier, it returns null. Otherwise it returns the associated contact group.

Returns:

the contact group associated with the given identifier, or null.