oracle.sdp.presence.integration
Interface VCard

All Superinterfaces:

java.lang.Cloneable

public interface VCard
extends java.lang.Cloneable

Abstraction of an entity's business card (vcard), partially based on RFC 2426.

Method Summary

boolean	addPhoneNumber(PhoneNumber number) Adds the PhoneNumber number if has not already been added otherwise does nothing
java.lang.Object	clone()
PhoneNumber	createPhoneNumber(PhoneNumber.Type type, java.lang.String number) Create a new phone number of the specified type.
java.lang.String	getCity()
java.lang.String	getCountry()
java.lang.String	getEmail()
java.lang.String	getFullName()
java.lang.String	getNickName()
List<PhoneNumber>	getPhoneNumbers()
java.lang.String	getPostalCode()
java.lang.String	getState()
java.lang.String	getStreetAddress()
java.lang.String	getWebAddress()
boolean	removePhoneNumber(PhoneNumber number) Removes the phone number from this VCard.
void	setCity(java.lang.String city) sets this.city to city
void	setCountry(java.lang.String country) sets this.country to country
void	setEmail(java.lang.String email) Set this.email
void	setFullName(java.lang.String name) Set this.fullname to name
void	setNickName(java.lang.String name) Set this.nickname to name
void	setPostalCode(java.lang.String postalCode) sets this.postalcode to postalCode
void	setState(java.lang.String state) sets this.state to state
void	setStreetAddress(java.lang.String address) sets this.address to address
void	setWebAddress(java.lang.String address) set this.address to address

Method Detail

addPhoneNumber

boolean addPhoneNumber(PhoneNumber number)

Adds the PhoneNumber number if has not already been added otherwise does nothing

Parameters:

number - the number to add

Returns:

true if the number is added otherwise this Vcard already contains the number and the method returns false.

clone

java.lang.Object clone()

Returns:

a clone of this vcard

createPhoneNumber

PhoneNumber createPhoneNumber(PhoneNumber.Type type,
                              java.lang.String number)
                              throws java.lang.IllegalArgumentException

Create a new phone number of the specified type.

Returns:

a new phone number of the specified type.

Throws:

java.lang.IllegalArgumentException - in case the number is null or the empty string

getCity

java.lang.String getCity()

Returns:

this.city

getCountry

java.lang.String getCountry()

Returns:

this.country

getEmail

java.lang.String getEmail()

Returns:

this.email

getFullName

java.lang.String getFullName()

Returns:

this.fullname

getNickName

java.lang.String getNickName()

Returns:

this.nickname

getPhoneNumbers

List<PhoneNumber> getPhoneNumbers()

Returns:

a copy of list of phone numbers in this Vcard. Modifying elements of the return list does NOT modify the phone numbers in this Vcard

getPostalCode

java.lang.String getPostalCode()

Returns:

this.postalcode

getState

java.lang.String getState()

Returns:

this.state

getStreetAddress

java.lang.String getStreetAddress()

Returns:

this.streetaddress

getWebAddress

java.lang.String getWebAddress()

Returns:

this.webaddress

removePhoneNumber

boolean removePhoneNumber(PhoneNumber number)

Removes the phone number from this VCard. Returns true If the phone number is removed; if the phone number is not found this method will have no effect and return false.

Parameters:

number - the number to remove

setCity

void setCity(java.lang.String city)

sets this.city to city

Parameters:

city -

setCountry

void setCountry(java.lang.String country)

sets this.country to country

Parameters:

country -

setEmail

void setEmail(java.lang.String email)

Set this.email

Parameters:

email -

setFullName

void setFullName(java.lang.String name)

Set this.fullname to name

Parameters:

name -

setNickName

void setNickName(java.lang.String name)

Set this.nickname to name

setPostalCode

void setPostalCode(java.lang.String postalCode)

sets this.postalcode to postalCode

Parameters:

postalCode -

setState

void setState(java.lang.String state)

sets this.state to state

Parameters:

state -

setStreetAddress

void setStreetAddress(java.lang.String address)

sets this.address to address

Parameters:

address -

setWebAddress

void setWebAddress(java.lang.String address)

set this.address to address

Parameters:

address -