com.google.gdata.model.gd
Class Who

java.lang.Object
  extended by com.google.gdata.model.Element
      extended by com.google.gdata.model.gd.Who

public class Who
extends Element

Describes a person associated with the containing entity.


Nested Class Summary
static class Who.Rel
          Relationship between the containing entity and the contained person.
 
Field Summary
static AttributeKey<java.lang.String> EMAIL
          Email address.
static ElementKey<java.lang.Void,Who> KEY
          The key for this element.
static AttributeKey<java.lang.String> REL
          Relationship between the containing entity and the contained person.
static AttributeKey<java.lang.String> VALUE_STRING
          Simple string value that can be used as a representation of this person.
 
Constructor Summary
  Who()
          Constructs an instance using the default key.
protected Who(ElementKey<?,? extends Who> key)
          Subclass constructor, allows subclasses to supply their own element key.
protected Who(ElementKey<?,? extends Who> key, Element source)
          Constructs a new instance by doing a shallow copy of data from an existing Element instance.
 
Method Summary
 AttendeeStatus getAttendeeStatus()
          Returns the event attendee status.
 AttendeeType getAttendeeType()
          Returns the event attendee type.
 java.lang.String getEmail()
          Returns the email address.
 EntryLink getEntryLink()
          Returns the nested person entry.
 java.lang.String getRel()
          Returns the relationship between the containing entity and the contained person.
 java.lang.String getValueString()
          Returns the simple string value that can be used as a representation of this person.
 boolean hasAttendeeStatus()
          Returns whether it has the event attendee status.
 boolean hasAttendeeType()
          Returns whether it has the event attendee type.
 boolean hasEmail()
          Returns whether it has the email address.
 boolean hasEntryLink()
          Returns whether it has the nested person entry.
 boolean hasRel()
          Returns whether it has the relationship between the containing entity and the contained person.
 boolean hasValueString()
          Returns whether it has the simple string value that can be used as a representation of this person.
 Who lock()
          Locks this element.
static void registerMetadata(MetadataRegistry registry)
          Registers the metadata for this element.
 Who setAttendeeStatus(AttendeeStatus attendeeStatus)
          Sets the event attendee status.
 Who setAttendeeType(AttendeeType attendeeType)
          Sets the event attendee type.
 Who setEmail(java.lang.String email)
          Sets the email address.
 Who setEntryLink(EntryLink entryLink)
          Sets the nested person entry.
 Who setRel(java.lang.String rel)
          Sets the relationship between the containing entity and the contained person.
 Who setValueString(java.lang.String valueString)
          Sets the simple string value that can be used as a representation of this person.
 
Methods inherited from class com.google.gdata.model.Element
adapt, adapt, addElement, addElement, addElement, clear, createElement, createElement, eq, equals, getAttributeCount, getAttributeIterator, getAttributeIterator, getAttributeValue, getAttributeValue, getDefaultKey, getElement, getElement, getElementCount, getElementId, getElementIterator, getElementIterator, getElementKey, getElements, getElements, getElementSet, getElementSet, getElementValue, getElementValue, getTextValue, getTextValue, hasAttribute, hasAttribute, hasElement, hasElement, hashCode, hasTextValue, isLocked, narrow, removeAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeElement, removeElement, removeElement, removeElement, replaceElement, resolve, resolve, sameClassAs, setAttributeValue, setAttributeValue, setElement, setElement, setElement, setTextValue, toString, validate, visit
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

KEY

public static final ElementKey<java.lang.Void,Who> KEY
The key for this element.


EMAIL

public static final AttributeKey<java.lang.String> EMAIL
Email address.


REL

public static final AttributeKey<java.lang.String> REL
Relationship between the containing entity and the contained person.


VALUE_STRING

public static final AttributeKey<java.lang.String> VALUE_STRING
Simple string value that can be used as a representation of this person.

Constructor Detail

Who

public Who()
Constructs an instance using the default key.


Who

protected Who(ElementKey<?,? extends Who> key)
Subclass constructor, allows subclasses to supply their own element key.


Who

protected Who(ElementKey<?,? extends Who> key,
              Element source)
Constructs a new instance by doing a shallow copy of data from an existing Element instance. Will use the given ElementKey as the key for the element. This constructor is used when adapting from one element key to another. You cannot call this constructor directly, instead use Element.createElement(ElementKey, Element).

Parameters:
key - The key to use for this element.
source - source element
Method Detail

registerMetadata

public static void registerMetadata(MetadataRegistry registry)
Registers the metadata for this element.


lock

public Who lock()
Description copied from class: Element
Locks this element. A locked element cannot have any changes made to its content or its attributes or child elements. This will also lock all attributes and child elements as well. Once this method has been called, this element can be safely published to other threads.

Overrides:
lock in class Element

getAttendeeStatus

public AttendeeStatus getAttendeeStatus()
Returns the event attendee status.

Returns:
event attendee status

setAttendeeStatus

public Who setAttendeeStatus(AttendeeStatus attendeeStatus)
Sets the event attendee status.

Parameters:
attendeeStatus - event attendee status or null to reset
Returns:
this to enable chaining setters

hasAttendeeStatus

public boolean hasAttendeeStatus()
Returns whether it has the event attendee status.

Returns:
whether it has the event attendee status

getAttendeeType

public AttendeeType getAttendeeType()
Returns the event attendee type.

Returns:
event attendee type

setAttendeeType

public Who setAttendeeType(AttendeeType attendeeType)
Sets the event attendee type.

Parameters:
attendeeType - event attendee type or null to reset
Returns:
this to enable chaining setters

hasAttendeeType

public boolean hasAttendeeType()
Returns whether it has the event attendee type.

Returns:
whether it has the event attendee type

getEmail

public java.lang.String getEmail()
Returns the email address.

Returns:
email address

setEmail

public Who setEmail(java.lang.String email)
Sets the email address.

Parameters:
email - email address or null to reset
Returns:
this to enable chaining setters

hasEmail

public boolean hasEmail()
Returns whether it has the email address.

Returns:
whether it has the email address

getEntryLink

public EntryLink getEntryLink()
Returns the nested person entry.

Returns:
nested person entry

setEntryLink

public Who setEntryLink(EntryLink entryLink)
Sets the nested person entry.

Parameters:
entryLink - nested person entry or null to reset
Returns:
this to enable chaining setters

hasEntryLink

public boolean hasEntryLink()
Returns whether it has the nested person entry.

Returns:
whether it has the nested person entry

getRel

public java.lang.String getRel()
Returns the relationship between the containing entity and the contained person.

Returns:
relationship between the containing entity and the contained person

setRel

public Who setRel(java.lang.String rel)
Sets the relationship between the containing entity and the contained person.

Parameters:
rel - relationship between the containing entity and the contained person or null to reset
Returns:
this to enable chaining setters

hasRel

public boolean hasRel()
Returns whether it has the relationship between the containing entity and the contained person.

Returns:
whether it has the relationship between the containing entity and the contained person

getValueString

public java.lang.String getValueString()
Returns the simple string value that can be used as a representation of this person.

Returns:
simple string value that can be used as a representation of this person

setValueString

public Who setValueString(java.lang.String valueString)
Sets the simple string value that can be used as a representation of this person.

Parameters:
valueString - simple string value that can be used as a representation of this person or null to reset
Returns:
this to enable chaining setters

hasValueString

public boolean hasValueString()
Returns whether it has the simple string value that can be used as a representation of this person.

Returns:
whether it has the simple string value that can be used as a representation of this person