com.vodafone360.people.engine.presence
Class User

java.lang.Object
  extended by com.vodafone360.people.engine.presence.User

public class User
extends java.lang.Object

User is a class encapsulating the information about a user's presence state.


Field Summary
private static java.lang.String COLUMNS
           
private  long mLocalContactId
           
private  int mOverallOnline
           
private  java.util.ArrayList<NetworkPresence> mPayload
           
 
Constructor Summary
User()
          Default Constructor.
User(java.lang.String userId, java.util.Hashtable<java.lang.String,java.lang.String> payload)
          Constructor.
 
Method Summary
private static java.util.ArrayList<NetworkPresence> createPayload(java.lang.String userId, java.util.Hashtable<java.lang.String,java.lang.String> payload)
           
 boolean equals(java.lang.Object obj)
           
 long getLocalContactId()
          This method returns the localContactId for this contact in DB across the application .
 java.util.ArrayList<NetworkPresence> getPayload()
          Returns communities presence status
 ContactSummary.OnlineStatus getStatusForNetwork(NetworkPresence.SocialNetwork network)
           
 int hashCode()
           
 int isOnline()
          Returns the overall user presence status: in fact the one from the below status states first encountered for all known user accounts next: INVISIBLE, ONLINE, IDLE, OFFLINE
private  int isOverallOnline(java.util.Hashtable<java.lang.String,java.lang.String> payload)
          Returns the overall user presence status
private static java.lang.String parseUserName(java.lang.String userId)
           
 void setLocalContactId(long mLocalContactId)
           
 void setOverallOnline(int overallOnline)
           
 void setPayload(java.util.ArrayList<NetworkPresence> payload)
          Returns communities presence status
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

COLUMNS

private static final java.lang.String COLUMNS
See Also:
Constant Field Values

mLocalContactId

private long mLocalContactId

mOverallOnline

private int mOverallOnline

mPayload

private java.util.ArrayList<NetworkPresence> mPayload
Constructor Detail

User

public User()
Default Constructor.


User

public User(java.lang.String userId,
            java.util.Hashtable<java.lang.String,java.lang.String> payload)
Constructor.

Parameters:
userId - - user id in the contact list, e.g. "google::userid@gmail.com" or "882339"
payload - - communities presence status {google:online, pc:online, mobile:online}
Method Detail

getLocalContactId

public long getLocalContactId()
This method returns the localContactId for this contact in DB across the application .

Returns:
the localContactId for this contact in DB

setLocalContactId

public void setLocalContactId(long mLocalContactId)

getPayload

public java.util.ArrayList<NetworkPresence> getPayload()
Returns communities presence status

Returns:
communities presence status, e.g. {google:online, pc:online, mobile:online}

getStatusForNetwork

public ContactSummary.OnlineStatus getStatusForNetwork(NetworkPresence.SocialNetwork network)

setPayload

public void setPayload(java.util.ArrayList<NetworkPresence> payload)
Returns communities presence status


isOverallOnline

private int isOverallOnline(java.util.Hashtable<java.lang.String,java.lang.String> payload)
Returns the overall user presence status

Returns:
true if user is online at least at one community, e.g. true if {google:offline, pc:offline, mobile:online}

isOnline

public int isOnline()
Returns the overall user presence status: in fact the one from the below status states first encountered for all known user accounts next: INVISIBLE, ONLINE, IDLE, OFFLINE

Returns:
presence state

createPayload

private static java.util.ArrayList<NetworkPresence> createPayload(java.lang.String userId,
                                                                  java.util.Hashtable<java.lang.String,java.lang.String> payload)
Parameters:
payload -
Returns:

parseUserName

private static java.lang.String parseUserName(java.lang.String userId)
Parameters:
user -
Returns:

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

setOverallOnline

public void setOverallOnline(int overallOnline)


JavaDoc