public class

ListPageEntry

extends BasePageEntry<E extends BasePageEntry<E>>
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.BaseEntry<E extends com.google.gdata.data.BaseEntry>
         ↳ com.google.gdata.data.media.MediaEntry<E extends com.google.gdata.data.BaseEntry<E>>
           ↳ com.google.gdata.data.sites.BaseContentEntry<E extends com.google.gdata.data.sites.BaseContentEntry<E>>
             ↳ com.google.gdata.data.sites.BasePageEntry<E extends com.google.gdata.data.sites.BasePageEntry<E>>
               ↳ com.google.gdata.data.sites.ListPageEntry

Class Overview

Describes a list page entry.

Summary

Constants
String KIND Listpage list page kind kind term value.
Fields
public static final Category CATEGORY Listpage list page kind kind category.
[Expand]
Inherited Fields
From class com.google.gdata.data.BaseEntry
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
ListPageEntry()
Default mutable constructor.
ListPageEntry(BaseEntry<?> sourceEntry)
Constructs a new instance by doing a shallow copy of data from an existing BaseEntry instance.
Public Methods
void declareExtensions(ExtensionProfile extProfile)
Declares the set of expected Extension types for an ExtensionPoint within the target extension profile.
Link getAtomAttachmentsLink()
Returns the attachments sites link.
Link getAtomRepliesLink()
Returns the replies sites link.
Data getData()
Returns the data region of a table.
FeedLink getFeedLink()
Returns the A feedLink element representing the feed for list items in this page.
Header getHeader()
Returns the header row.
Link getHtmlAttachmentsLink()
Returns the attachments sites link.
Link getHtmlRepliesLink()
Returns the replies sites link.
Link getParentLink()
Returns the parent sites link.
Worksheet getWorksheet()
Returns the worksheet where the table lives.
boolean hasData()
Returns whether it has the data region of a table.
boolean hasFeedLink()
Returns whether it has the A feedLink element representing the feed for list items in this page.
boolean hasHeader()
Returns whether it has the header row.
boolean hasWorksheet()
Returns whether it has the worksheet where the table lives.
void setData(Data data)
Sets the data region of a table.
void setFeedLink(FeedLink feedLink)
Sets the A feedLink element representing the feed for list items in this page.
void setHeader(Header header)
Sets the header row.
void setWorksheet(Worksheet worksheet)
Sets the worksheet where the table lives.
String toString()
Protected Methods
void validate()
Checks the attributes to see if there are any problems.
[Expand]
Inherited Methods
From class com.google.gdata.data.sites.BasePageEntry
From class com.google.gdata.data.sites.BaseContentEntry
From class com.google.gdata.data.media.MediaEntry
From class com.google.gdata.data.BaseEntry
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
From class java.lang.Object
From interface com.google.gdata.data.Extension
From interface com.google.gdata.data.IAtom
From interface com.google.gdata.data.IEntry
From interface com.google.gdata.data.Kind.Adaptable
From interface com.google.gdata.data.Kind.Adaptor
From interface com.google.gdata.data.media.IMediaEntry

Constants

public static final String KIND

Listpage list page kind kind term value.

Constant Value: "http://schemas.google.com/sites/2008#listpage"

Fields

public static final Category CATEGORY

Listpage list page kind kind category.

Public Constructors

public ListPageEntry ()

Default mutable constructor.

public ListPageEntry (BaseEntry<?> sourceEntry)

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

Parameters
sourceEntry Source entry

Public Methods

public void declareExtensions (ExtensionProfile extProfile)

Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. The base implementation does not declare any extensions, but can be overridden by specific types of ExtensionPoints that always contain a well-defined set of extensions.

Parameters
extProfile The ExtensionProfile to initialize.

public Link getAtomAttachmentsLink ()

Returns the attachments sites link.

Returns
  • Attachments sites link or null for none.

public Link getAtomRepliesLink ()

Returns the replies sites link.

Returns
  • Replies sites link or null for none.

public Data getData ()

Returns the data region of a table.

Returns
  • data region of a table

public FeedLink getFeedLink ()

Returns the A feedLink element representing the feed for list items in this page.

Returns
  • A feedLink element representing the feed for list items in this page

public Header getHeader ()

Returns the header row.

Returns
  • header row

public Link getHtmlAttachmentsLink ()

Returns the attachments sites link.

Returns
  • Attachments sites link or null for none.

public Link getHtmlRepliesLink ()

Returns the replies sites link.

Returns
  • Replies sites link or null for none.

public Link getParentLink ()

Returns the parent sites link.

Returns
  • Parent sites link or null for none.

public Worksheet getWorksheet ()

Returns the worksheet where the table lives.

Returns
  • worksheet where the table lives

public boolean hasData ()

Returns whether it has the data region of a table.

Returns
  • whether it has the data region of a table

public boolean hasFeedLink ()

Returns whether it has the A feedLink element representing the feed for list items in this page.

Returns
  • whether it has the A feedLink element representing the feed for list items in this page

public boolean hasHeader ()

Returns whether it has the header row.

Returns
  • whether it has the header row

public boolean hasWorksheet ()

Returns whether it has the worksheet where the table lives.

Returns
  • whether it has the worksheet where the table lives

public void setData (Data data)

Sets the data region of a table.

Parameters
data Data region of a table or null to reset

public void setFeedLink (FeedLink feedLink)

Sets the A feedLink element representing the feed for list items in this page.

Parameters
feedLink A feedLink element representing the feed for list items in this page or null to reset

public void setHeader (Header header)

Sets the header row.

Parameters
header Header row or null to reset

public void setWorksheet (Worksheet worksheet)

Sets the worksheet where the table lives.

Parameters
worksheet Worksheet where the table lives or null to reset

public String toString ()

Protected Methods

protected void validate ()

Checks the attributes to see if there are any problems. Default implementation does nothing, though generally this is discouraged unless there really are no restrictions.