org.glassfish.cafe.api.presence
Interface ServiceInformation

All Superinterfaces:

PresenceInformation

public interface ServiceInformation
extends PresenceInformation

Specifies a set of presence information elements that are typically used as presence information for a service. The �service� component (defined in [RFC4479]) SHALL be mapped to the element. The element is specified in [RFC3863].

Nested Class Summary

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

PresenceInformation.Status

Method Summary

GeographicalLocation	createGeographicalLocation() Creates a GeographicalLocation and adds it to this ServiceInformation.
String	getContact() Returns the contact information.
String	getContactPriority() Gets contact information priority.
String	getDeviceID() Gets Per service device identifier..
GeographicalLocation	getGeographicalLocationInfo() Returns a GeographicalLocationInfo interface representing the geographical location of this service.
String	getId() Returns the service id.
String	getServiceDescriptionText() Gets the ServiceDescriptionText.
String	getServiceID() Gets the service ID.
PresenceInformation.Status	getStatus() Gets service status: OPEN or CLOSE.
String	getStatusIcon() Gets the status icon.
String	getVersion() Gets the version.
PresenceInformation.Status	getWillingness() The element is an extension to PIDF that is used to describe the �Application-specific willingness�
void	setContact(String contact) Sets contacts value.
void	setContactPriority(String value) Sets contact priority information.
void	setDeviceID(String deviceID) Sets Per service device identifier.
void	setNote(String statusMessage) Sets note.
void	setServiceDescriptionText(String text) The element is an extension to PIDF that is used to describe OMA-specific services.
void	setStatus(PresenceInformation.Status status) Sets service status: OPEN or CLOSE.
void	setStatusIcon(String icon) Sets a new status icon.
void	setWillingness(PresenceInformation.Status status) Sets the willingness status.

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

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

Method Detail

getId

String getId()

Returns the service id.

getContact

String getContact()

Returns the contact information.

setContact

void setContact(String contact)

Sets contacts value. Part of RCS specification.

getContactPriority

String getContactPriority()

Gets contact information priority.

setContactPriority

void setContactPriority(String value)

Sets contact priority information.

setStatus

void setStatus(PresenceInformation.Status status)

Sets service status: OPEN or CLOSE.

getStatus

PresenceInformation.Status getStatus()

Gets service status: OPEN or CLOSE.

setNote

void setNote(String statusMessage)

Sets note.

setStatusIcon

void setStatusIcon(String icon)

Sets a new status icon.

getStatusIcon

String getStatusIcon()

Gets the status icon.

setWillingness

void setWillingness(PresenceInformation.Status status)

Sets the willingness status.

getWillingness

PresenceInformation.Status getWillingness()

The element is an extension to PIDF that is used to describe the �Application-specific willingness�

setDeviceID

void setDeviceID(String deviceID)

Sets Per service device identifier.

getDeviceID

String getDeviceID()

Gets Per service device identifier..

getServiceID

String getServiceID()

Gets the service ID.

getVersion

String getVersion()

Gets the version.

getServiceDescriptionText

String getServiceDescriptionText()

Gets the ServiceDescriptionText.

setServiceDescriptionText

void setServiceDescriptionText(String text)

The element is an extension to PIDF that is used to describe OMA-specific services.

createGeographicalLocation

GeographicalLocation createGeographicalLocation()

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

Returns:

GeographicalLocation instance.

getGeographicalLocationInfo

GeographicalLocation getGeographicalLocationInfo()

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

Returns:

the GeographicalLocation or null if the geographical location is not available