org.opensocial.models

Class Person

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

org.json.simple.JSONObject

org.opensocial.models.Model

org.opensocial.models.Person

All Implemented Interfaces:

Serializable, Cloneable, Map, org.json.simple.JSONAware, org.json.simple.JSONStreamAware

public class Person
extends Model

OpenSocial model class representing a person/user. For reference: http://wiki.opensocial.org/index.php?title=Opensocial.Person_(v0.9) http://www .opensocial.org/Technical-Resources/opensocial-spec-v09/REST-API.html #rfc.section.3.2

Author:

Jason Cooper

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Person()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayName() Returns the user's display name or nickname
String	getEmail()
String	getFamliyName() Returns the user's family name
String	getFormattedName()
String	getGivenName() Returns the user's given name
String	getId() Returns the user's OpenSocial ID.
String	getThumbnailUrl() Returns the user's photo thumbnail URL as a string.
String	getVootMembershipRole()
boolean	isGuest() Returns the guest status of the Person

Methods inherited from class org.opensocial.models.Model

addTemplateParameter, addToListField, getField, getFieldAsList, getFieldAsMap, getFieldAsString, getFieldNames, getTemplateParameter, hasField, isFieldMultikeyed, isFieldMultivalued, setField

Methods inherited from class org.json.simple.JSONObject

escape, toJSONString, toJSONString, toString, toString, writeJSONString, writeJSONString

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

Person

public Person()

Method Detail

getId

public String getId()

Returns the user's OpenSocial ID.

Returns:

OpenSocial ID

getDisplayName

public String getDisplayName()

Returns the user's display name or nickname

Returns:

user's display name or nickname; if neither field is set, unknown is returned.

getGivenName

public String getGivenName()

Returns the user's given name

Returns:

user's given name; if field is not set, unknown is returned.

getFamliyName

public String getFamliyName()

Returns the user's family name

Returns:

user's family name; if field is not set, unknown is returned.

getFormattedName

public String getFormattedName()

getThumbnailUrl

public String getThumbnailUrl()

Returns the user's photo thumbnail URL as a string.

Returns:

String with the location of the thumbnail

getEmail

public String getEmail()

Returns:

first known email address of the Person, can be null

getVootMembershipRole

public String getVootMembershipRole()

isGuest

public boolean isGuest()

Returns the guest status of the Person

Returns:

true if the Person is tagged as guest