org.opengroupware.jogi.ogo
Interface Phone

All Known Implementing Classes:

XmlRpcPhone

public interface Phone

Represents a telephone object with its attributes. A telephone Object is usually not used standalone, instead it is part of other objects like a Person. There are currently the following types of phone objects available:

• 02_tel
• 03_tel_funk
• 15_fax_private
• 01_tel
• 05_tel_private

Author:

Andreas Rath (teddius) E-Mail: arath@htu.tugraz.at, Walter Christian

Method Summary

java.lang.String	getId() Get the id of this phone object.
java.lang.String	getInfo() Get the info which is associated with this phone object.
java.lang.String	getNumber() Get the number for this phone object.
java.lang.String	getType() Get the type of this phone object.
void	setInfo(java.lang.String info) Set the info for this telephone object.
void	setNumber(java.lang.String number) Set the number.
void	setType(java.lang.String type) Set the new type of this phone object.

Method Detail

getId

public java.lang.String getId()
                       throws OgoException,
                              ConnectionException

Get the id of this phone object. The id is unique for all telephones in all objects.

Returns:

A string representation of the id

Throws:

OgoException

ConnectionException

getInfo

public java.lang.String getInfo()
                         throws OgoException,
                                ConnectionException

Get the info which is associated with this phone object.

Returns:

The info.

Throws:

OgoException

ConnectionException

setInfo

public void setInfo(java.lang.String info)
             throws OgoException,
                    ConnectionException

Set the info for this telephone object.

Parameters:

info - The info to set for this phone object.

Throws:

OgoException

ConnectionException

getNumber

public java.lang.String getNumber()
                           throws OgoException,
                                  ConnectionException

Get the number for this phone object. For example 0043-676-1212431.

Returns:

The number.

Throws:

OgoException

ConnectionException

setNumber

public void setNumber(java.lang.String number)
               throws OgoException,
                      ConnectionException

Set the number. You can use any format you want for setting the number.

Parameters:

number - The new number.

Throws:

OgoException

ConnectionException

getType

public java.lang.String getType()
                         throws OgoException,
                                ConnectionException

Get the type of this phone object. See the list for currently supported and available types.

Returns:

The type of this phone object.

Throws:

OgoException

ConnectionException

setType

public void setType(java.lang.String type)
             throws OgoException,
                    ConnectionException

Set the new type of this phone object. See the list above for currently supported and available types.

Parameters:

type - The new type for this phone object.

Throws:

OgoException

ConnectionException