com.ibm.presence.api.datamodel
Interface Presence

All Superinterfaces:
java.io.Serializable

public interface Presence
extends java.io.Serializable

This interface is defined to represence a presence.


Field Summary
static int PRESENCE_TYPE_GROUP
          Constant represent a group presence type .
static int PRESENCE_TYPE_SINGLE
          Constant represent a singe presence type .
static int PRESENCE_TYPE_UNKNOWN
          Constant represent a unknown presence type .
static int PRESENCE_TYPE_URI_LIST
          Constant represent a URI list presence type .
 
Method Summary
 java.lang.String getDisplayName()
          Returns the display name of the presentity.
 java.lang.String getOriginalPresenceId()
          Return the original case sensitive id of this Presence.
 java.lang.String getPresenceId()
          Return the id of this Presence, case insensitive.
 int getType()
          Return the type of this presence.
 boolean isGroup()
          Return true if type is group, else return false
 boolean isSingle()
          Return true if type is single, else return false
 boolean isUriList()
          Return true if type is URI list, else return false
 void setDisplayName(java.lang.String displayName)
           
 void setType(int type)
          Set the type of this presence .
 

Field Detail

PRESENCE_TYPE_UNKNOWN

static final int PRESENCE_TYPE_UNKNOWN
Constant represent a unknown presence type .

See Also:
Constant Field Values

PRESENCE_TYPE_SINGLE

static final int PRESENCE_TYPE_SINGLE
Constant represent a singe presence type .

See Also:
Constant Field Values

PRESENCE_TYPE_GROUP

static final int PRESENCE_TYPE_GROUP
Constant represent a group presence type .

See Also:
Constant Field Values

PRESENCE_TYPE_URI_LIST

static final int PRESENCE_TYPE_URI_LIST
Constant represent a URI list presence type .

See Also:
Constant Field Values
Method Detail

getType

int getType()
Return the type of this presence.

Returns:
the type of this presence.

isGroup

boolean isGroup()
Return true if type is group, else return false

Returns:
true if type is group

isSingle

boolean isSingle()
Return true if type is single, else return false

Returns:
true if type is single

isUriList

boolean isUriList()
Return true if type is URI list, else return false

Returns:
true if type is URI list

setType

void setType(int type)
Set the type of this presence .

Parameters:
type - the type of this presence.

getPresenceId

java.lang.String getPresenceId()
Return the id of this Presence, case insensitive.

Returns:
the id of this Presence.

getDisplayName

java.lang.String getDisplayName()
Returns the display name of the presentity.

Returns:
the display name.

setDisplayName

void setDisplayName(java.lang.String displayName)
Parameters:
displayName -

getOriginalPresenceId

java.lang.String getOriginalPresenceId()
Return the original case sensitive id of this Presence.

Returns:
the id of this Presence.


Copyright © 2003 IBM Corp. All Rights Reserved.