org.glassfish.cafe.api.presence
Interface PersonInformation

All Superinterfaces:

PresenceInformation

public interface PersonInformation
extends PresenceInformation

Specifies a set of methods and attributes used for storing, modifying and retrieving presence information. The person data component models information about the user whom the presence data is trying to describe.

The �person� component SHALL be mapped to the element. A time stamp will be added when the element is published (RCS). The element is specified in [RFC4479].

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.cafe.api.presence.PresenceInformation

PresenceInformation.Status

Method Summary

void	addActivities(String[] activities) Adds a number of new activities.
void	addActivity(String activity) Adds a new activity.
void	addMood(String mood) Adds a new mood.
void	addMoods(String[] moods) Adds a number of new moods.
void	clearActivities() Removes the set of activities.
void	clearMoods() Removes the set of activities.
GeographicalLocation	createGeographicalLocation() Creates a GeographicalLocation and adds it to this PersonInformation.
String[]	getActivities() Returns the set of activities.
String	getCard() Gets the CIPID card for this person.
String	getDisplayName() Gets the CIPID display name for this person.
GeographicalLocation	getGeographicalLocationInfo() Returns a GeographicalLocationInfo interface representing the geographical location of this person.
String	getHomepage() Gets the CIPID homepage for this person.
String	getIcon() Gets the CIPID icon for this person.
String	getId() Returns the person identifier.
String	getMap() Gets the CIPID map name for this person.
String[]	getMoods() Returns the set of moods.
PresenceInformation.Status	getOverridingWillingness() Gets the willingness status.
String	getSound() Gets the CIPID sound name for this person.
String	getStatusIcon() Gets the status icon for this person.
boolean	removeActivity(String activity) Removes an activity.
boolean	removeMood(String mood) Removes a mood.
void	setCard(String aCard) Sets the CIPID card for this person.
void	setDisplayName(String aDisplayName) Sets the CIPID display name for this person.
void	setHomepage(String aHomepage) Sets the CIPID home page for this person.
void	setIcon(String aIcon) Sets the CIPID icon for this person.
void	setMap(String aMap) Sets the CIPID map name for this person.
void	setNote(String note) Sets a note.
void	setOverridingWillingness(PresenceInformation.Status status) Sets the willingness status.
void	setSound(String aSound) Sets the CIPID sound name for this person.
void	setStatusIcon(String icon) Sets a new status icon.

Methods inherited from interface org.glassfish.cafe.api.presence.PresenceInformation

addElement, getElementNS, getElementsNS, getNote, getNotes, getRpidClass, getTimeStamp, setRpidClass

Method Detail

setOverridingWillingness

void setOverridingWillingness(PresenceInformation.Status status)

Sets the willingness status. Part of OMA and RCS specifications. �Open� = Willing, �Closed� = Not Willing.

getOverridingWillingness

PresenceInformation.Status getOverridingWillingness()

Gets the willingness status.

getId

String getId()

Returns the person identifier.

addActivity

void addActivity(String activity)

Adds a new activity.

addActivities

void addActivities(String[] activities)

Adds a number of new activities.

getActivities

String[] getActivities()

Returns the set of activities.

removeActivity

boolean removeActivity(String activity)

Removes an activity.

Returns:

true if the activities changed as a result of the call

clearActivities

void clearActivities()

Removes the set of activities.

addMood

void addMood(String mood)

Adds a new mood.

addMoods

void addMoods(String[] moods)

Adds a number of new moods.

getMoods

String[] getMoods()

Returns the set of moods.

removeMood

boolean removeMood(String mood)

Removes a mood.

Returns:

true if the activities changed as a result of the call

clearMoods

void clearMoods()

Removes the set of activities.

setNote

void setNote(String note)

Sets a note. Part of RCS.

setStatusIcon

void setStatusIcon(String icon)

Sets a new status icon. Part of RCS. The String is a HTTP URL where the icon can be fetched.

setCard

void setCard(String aCard)

Sets the CIPID card for this person.

setDisplayName

void setDisplayName(String aDisplayName)

Sets the CIPID display name for this person.

setHomepage

void setHomepage(String aHomepage)

Sets the CIPID home page for this person. Part of RCS. Typically a URI pointing to a web home page.

setIcon

void setIcon(String aIcon)

Sets the CIPID icon for this person.

setMap

void setMap(String aMap)

Sets the CIPID map name for this person.

setSound

void setSound(String aSound)

Sets the CIPID sound name for this person.

getStatusIcon

String getStatusIcon()

Gets the status icon for this person.

getCard

String getCard()

Gets the CIPID card for this person.

getDisplayName

String getDisplayName()

Gets the CIPID display name for this person.

getHomepage

String getHomepage()

Gets the CIPID homepage for this person.

getIcon

String getIcon()

Gets the CIPID icon for this person.

getMap

String getMap()

Gets the CIPID map name for this person.

getSound

String getSound()

Gets the CIPID sound name for this person.

createGeographicalLocation

GeographicalLocation createGeographicalLocation()

Creates a GeographicalLocation and adds it to this PersonInformation. This will replace any existing GeographicalLocation.

Returns:

GeographicalLocation instance.

getGeographicalLocationInfo

GeographicalLocation getGeographicalLocationInfo()

Returns a GeographicalLocationInfo interface representing the geographical location of this person.

Returns:

the GeographicalLocation or null if the geographical location is not available.