public class

MessageEntry

extends Entry

java.lang.Object
↳	com.google.gdata.model.Element
	↳	com.google.gdata.model.atom.Entry
		↳	com.google.gdata.model.gd.MessageEntry

Class Overview

Extension class for manipulating entries of the Message kind.

Summary

Constants
String	KIND	Message kind term value.

Fields
public static final Category	CATEGORY	Message kind category.
public static final ElementKey<Void, MessageEntry>	KEY	The key for this element.

[Expand]

Inherited Fields

From class com.google.gdata.model.atom.Entry

From class com.google.gdata.model.Element

Public Constructors
	MessageEntry() Constructs an instance using the default key.
	MessageEntry(Entry sourceEntry) Constructs a new instance by doing a shallow copy of data from an existing `Entry` instance.

Protected Constructors
	MessageEntry(ElementKey<?, ? extends MessageEntry> key) Subclass constructor, allows subclasses to supply their own element key.
	MessageEntry(ElementKey<?, ? extends MessageEntry> key, Entry source) Constructs a new instance by doing a shallow copy of data from an existing `Entry` instance.

Public Methods
MessageEntry	addWhoList(Who whoList) Adds a new person description.
void	clearWhoList() Removes all existing person description instances.
GeoPt	getGeoPt() Returns the geo pt.
Rating	getRating() Returns the rating.
When	getTime() Returns the time period description.
List<Who>	getWhoList() Returns the person descriptions.
boolean	hasGeoPt() Returns whether it has the geo pt.
boolean	hasRating() Returns whether it has the rating.
boolean	hasTime() Returns whether it has the time period description.
boolean	hasWhoList() Returns whether it has the person descriptions.
MessageEntry	lock() Locks this element.
static void	registerMetadata(MetadataRegistry registry) Registers the metadata for this element.
boolean	removeWhoList(Who whoList) Removes an existing person description.
MessageEntry	setGeoPt(GeoPt geoPt) Sets the geo pt.
MessageEntry	setRating(Rating rating) Sets the rating.
MessageEntry	setTime(When time) Sets the time period description.

[Expand]

Inherited Methods

From class com.google.gdata.model.atom.Entry

From class com.google.gdata.model.Element

From class java.lang.Object

From interface com.google.gdata.data.IAtom

abstract ILink	addLink(String rel, String type, String href) Adds a link with the given rel, type, and href.
abstract List<? extends IPerson>	getAuthors() Returns the list of all authors on this resource.
abstract Set<? extends ICategory>	getCategories() Returns a set of categories on this resource.
abstract String	getEtag() Gets the value of the gd:etag attribute for this resource.
abstract String	getId() Get the unique id for this resource.
abstract String	getKind() Returns the value of the gd:kind attribute for this resource.
abstract ILink	getLink(String rel, String type) Returns a particular atom:link element with the given rel and type, or null if one was not found.
abstract List<? extends ILink>	getLinks() Returns a list of atom:link elements on this resource.
abstract ILink	getSelfLink() Returns the self link for the resource.
abstract ITextConstruct	getTitle() Returns the atom:title element of this resource.
abstract DateTime	getUpdated() Get a `DateTime` instance representing the last time this resource was updated.
abstract String	getVersionId() Version ID.
abstract void	removeLinks(String relToMatch, String typeToMatch) Remove all links that match the given `rel` and `type` values.
abstract void	removeLinks() Removes all links from the this resource.
abstract void	setEtag(String etag) Sets the value of the gd:etag attribute for this resource.
abstract void	setId(String id) Sets the unique id for this resource.
abstract void	setKind(String kind) Sets the value of the gd:kind attribute for this resource.
abstract void	setService(Service s) Sets the service that this resource is being used with.
abstract void	setUpdated(DateTime updated) Sets the last time this resource was updated.
abstract void	setVersionId(String versionId) Sets the versionId.

From interface com.google.gdata.data.IEntry

abstract boolean	getCanEdit() Returns `true` if the entry can be modified by a client.
abstract IContent	getContent() Gets the content of this entry.
abstract ILink	getEditLink() Gets the edit link, which is the link to PUT an updated version of the entry to.
abstract DateTime	getEdited() Get a `DateTime` instance representing the last time this entry was edited.
abstract ILink	getMediaEditLink() Gets the media-edit link, which is the link to PUT an updated version of the media content to.
abstract DateTime	getPublished() Get a `DateTime` instance representing the time that this entry was created.
abstract ILink	getResumableEditMediaLink() Gets the resumable-edit-media link, which is the link to PUT an updated version of the media content to using Resumable Upload IO.
abstract String	getSelectedFields() Returns the set of selected fields for the entry if the entry contains a partial representation or `null` if it is a full representation.
abstract ITextConstruct	getSummary() Returns the atom:summary element of this entry.
abstract void	setCanEdit(boolean canEdit) Sets whether the server allows this entry to be modified by the client.
abstract void	setEdited(DateTime edited) Set the last time this entry was edited using the app:edited element.
abstract void	setPublished(DateTime published) Sets the date of publishing for this entry.
abstract void	setSelectedFields(String fields) Sets the current fields selection for this partial entry.

Constants

public static final String KIND

Message kind term value.

Constant Value: "http://schemas.google.com/g/2005#message"

Fields

public static final Category CATEGORY

Message kind category.

public static final ElementKey<Void, MessageEntry> KEY

The key for this element.

Public Constructors

public MessageEntry ()

Constructs an instance using the default key.

public MessageEntry (Entry sourceEntry)

Constructs a new instance by doing a shallow copy of data from an existing Entry instance.

Parameters

sourceEntry	Source entry

Protected Constructors

protected MessageEntry (ElementKey<?, ? extends MessageEntry> key)

Subclass constructor, allows subclasses to supply their own element key.

Parameters

key

protected MessageEntry (ElementKey<?, ? extends MessageEntry> key, Entry source)

Constructs a new instance by doing a shallow copy of data from an existing Entry 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 createElement(ElementKey, Element).

Parameters

key	The key to use for this element.
source	Source element

Public Methods

public MessageEntry addWhoList (Who whoList)

Adds a new person description.

Parameters

whoList	Person description

public void clearWhoList ()

Removes all existing person description instances.

public GeoPt getGeoPt ()

Returns the geo pt.

Returns

geo pt

public Rating getRating ()

Returns the rating.

Returns

rating

public When getTime ()

Returns the time period description.

Returns

time period description

public List<Who> getWhoList ()

Returns the person descriptions.

Returns

person descriptions

public boolean hasGeoPt ()

Returns whether it has the geo pt.

Returns

whether it has the geo pt

public boolean hasRating ()

Returns whether it has the rating.

Returns

whether it has the rating

public boolean hasTime ()

Returns whether it has the time period description.

Returns

whether it has the time period description

public boolean hasWhoList ()

Returns whether it has the person descriptions.

Returns

whether it has the person descriptions

public MessageEntry lock ()

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.

public static void registerMetadata (MetadataRegistry registry)

Registers the metadata for this element.

Parameters

registry

public boolean removeWhoList (Who whoList)

Removes an existing person description.

Parameters

whoList	Person description

Returns

true if the whoList was removed

public MessageEntry setGeoPt (GeoPt geoPt)

Sets the geo pt.

Parameters

geoPt	Geo pt or `null` to reset

Returns

this to enable chaining setters

public MessageEntry setRating (Rating rating)

Sets the rating.

Parameters

rating	Rating or `null` to reset

Returns

this to enable chaining setters

public MessageEntry setTime (When time)

Sets the time period description.

Parameters

time	Time period description or `null` to reset

Returns

this to enable chaining setters

Classes

MessageEntry

Class Overview

Summary

Constants

public static final String KIND

Fields

public static final Category CATEGORY

public static final ElementKey<Void, MessageEntry> KEY

Public Constructors

public MessageEntry ()

public MessageEntry (Entry sourceEntry)

Parameters

Protected Constructors

protected MessageEntry (ElementKey<?, ? extends MessageEntry> key)

Parameters

protected MessageEntry (ElementKey<?, ? extends MessageEntry> key, Entry source)

Parameters

Public Methods

public MessageEntry addWhoList (Who whoList)

Parameters

public void clearWhoList ()

public GeoPt getGeoPt ()

Returns

public Rating getRating ()

Returns

public When getTime ()

Returns

public List<Who> getWhoList ()

Returns

public boolean hasGeoPt ()

Returns

public boolean hasRating ()

Returns

public boolean hasTime ()

Returns

public boolean hasWhoList ()

Returns

public MessageEntry lock ()

public static void registerMetadata (MetadataRegistry registry)

Parameters

public boolean removeWhoList (Who whoList)

Parameters

Returns

public MessageEntry setGeoPt (GeoPt geoPt)

Parameters

Returns

public MessageEntry setRating (Rating rating)

Parameters

Returns

public MessageEntry setTime (When time)

Parameters

Returns