net.sourceforge.mflow.api
Interface Contact

All Known Implementing Classes:

ContactImpl

public interface Contact

A class for representing an entity with which communication can occur Serves primarily as a repository for ContactMethods, associated with a name

Version:

$Revision: 1.3 $

Author:

David Carr

Method Summary

void	addContactMethod(ContactMethod cm) Adds a ContactMethod
ContactMethod[]	getContactMethods() Accessor for all of the ContactMethods associated with this Contact
ContactMethod	getContactMethods(int index) Accessor for a single ContactMethod associated with this Contact
java.lang.String	getName() Accessor for the name
void	removeContactMethod(ContactMethod cm) Removes a ContactMethod if it is a member of this Contact
void	setContactMethods(ContactMethod[] cms) Mutator for all of the ContactMethods associated with this Contact
void	setContactMethods(int index, ContactMethod cm) Mutator for a single ContactMethod associated with this Contact
void	setName(java.lang.String name) Mutator for the name

Method Detail

setName

void setName(java.lang.String name)

Mutator for the name

Parameters:

name - the new name

getName

java.lang.String getName()

Accessor for the name

Returns:

the name

addContactMethod

void addContactMethod(ContactMethod cm)

Adds a ContactMethod

Parameters:

cm - the ContactMethod to add

removeContactMethod

void removeContactMethod(ContactMethod cm)

Removes a ContactMethod if it is a member of this Contact

Parameters:

cm - the ContactMethod to remove

getContactMethods

ContactMethod[] getContactMethods()

Accessor for all of the ContactMethods associated with this Contact

Returns:

an array of ContactMethods

setContactMethods

void setContactMethods(ContactMethod[] cms)

Mutator for all of the ContactMethods associated with this Contact

Parameters:

cms - an array of ContactMethods

getContactMethods

ContactMethod getContactMethods(int index)

Accessor for a single ContactMethod associated with this Contact

Parameters:

index - the index of the ContactMethod to return

Returns:

the ContactMethod at the specified index

setContactMethods

void setContactMethods(int index,
                       ContactMethod cm)

Mutator for a single ContactMethod associated with this Contact

Parameters:

index - the index of the ContactMethod to change

cm - the ContactMethod to set