net.sourceforge.mflow.api
Interface ContactMethod

All Superinterfaces:

Iconable

public interface ContactMethod

extends Iconable

Describes a method of reaching a Contact

Version:

$Revision: 1.3 $

Author:

David Carr

Field Summary

static int	VIEW_TYPE_MULTI Constant for ContactMethods that are best displayed in a Msg dialog
static int	VIEW_TYPE_SINGLE Constant for ContactMethods that are best displayed one Msg at a time

Method Summary

Contact	getContact() Accessor for the associated Contact
java.lang.String	getDisplayName() Accessor for the user-friendly name
java.lang.String	getIdentifier() Accessor for the identifier
int	getPreferredViewType() Returns the prefered view type
java.lang.String	getProtocol() Accessor for the protocol
java.lang.String	idString() Returns a String representing this ContactMethod in a parseable form (protocol:id)
void	setContact(Contact c) Mutator for the associated Contact
void	setIdentifier(java.lang.String id) Mutator for the identifier

Methods inherited from interface net.sourceforge.mflow.api.Iconable

getIcon

Field Detail

VIEW_TYPE_SINGLE

static final int VIEW_TYPE_SINGLE

Constant for ContactMethods that are best displayed one Msg at a time

See Also:

Constant Field Values

VIEW_TYPE_MULTI

static final int VIEW_TYPE_MULTI

Constant for ContactMethods that are best displayed in a Msg dialog

See Also:

Constant Field Values

Method Detail

getProtocol

java.lang.String getProtocol()

Accessor for the protocol

Returns:

the current protocol

setIdentifier

void setIdentifier(java.lang.String id)

Mutator for the identifier

Parameters:

id - the new identifier

getIdentifier

java.lang.String getIdentifier()

Accessor for the identifier

Returns:

the current identifier

getDisplayName

java.lang.String getDisplayName()

Accessor for the user-friendly name

Returns:

the display name for the contact method

setContact

void setContact(Contact c)

Mutator for the associated Contact

Parameters:

c - the Contact to associate with this ContactMethod

getContact

Contact getContact()

Accessor for the associated Contact

Returns:

the Contact to associate with this ContactMethod

idString

java.lang.String idString()

Returns a String representing this ContactMethod in a parseable form (protocol:id)

Returns:

a string representing this ContactMethod

See Also:

ContactMethodManager.parse(String)

getPreferredViewType

int getPreferredViewType()

Returns the prefered view type

Returns:

the prefered view type

See Also:

VIEW_TYPE_SINGLE, VIEW_TYPE_MULTI