public class

SidewikiAuthor

extends Person
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.Person
         ↳ com.google.gdata.data.sidewiki.SidewikiAuthor

Class Overview

Sidewiki author.

Summary

Constants
String XML_NAME XML element name
[Expand]
Inherited Fields
From class com.google.gdata.data.Person
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
SidewikiAuthor()
Default mutable constructor.
Public Methods
void declareExtensions(ExtensionProfile extProfile)
Declares the set of expected Extension types for an ExtensionPoint within the target extension profile.
static ExtensionDescription getDefaultDescription(boolean required, boolean repeatable)
Returns the extension description, specifying whether it is required, and whether it is repeatable.
SidewikiUserDescription getDescription()
Returns the Sidewiki author description.
EntriesNumber getNumEntries()
Returns the entries number.
Rating getRating()
Returns the user rating given by the user issued the request.
ResourceId getResourceId()
Returns the Sidewiki author id.
SidewikiThumbnail getThumbnail()
Returns the user portrait thumbnail url.
boolean hasDescription()
Returns whether it has the Sidewiki author description.
boolean hasNumEntries()
Returns whether it has the entries number.
boolean hasRating()
Returns whether it has the user rating given by the user issued the request.
boolean hasResourceId()
Returns whether it has the Sidewiki author id.
boolean hasThumbnail()
Returns whether it has the user portrait thumbnail url.
void setDescription(SidewikiUserDescription description)
Sets the Sidewiki author description.
void setNumEntries(EntriesNumber numEntries)
Sets the entries number.
void setRating(Rating rating)
Sets the user rating given by the user issued the request.
void setResourceId(ResourceId resourceId)
Sets the Sidewiki author id.
void setThumbnail(SidewikiThumbnail thumbnail)
Sets the user portrait thumbnail url.
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.Person
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.IPerson

Constants

static final String XML_NAME

XML element name

Constant Value: "author"

Public Constructors

public SidewikiAuthor ()

Default mutable constructor.

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 static ExtensionDescription getDefaultDescription (boolean required, boolean repeatable)

Returns the extension description, specifying whether it is required, and whether it is repeatable.

Parameters
required Whether it is required
repeatable Whether it is repeatable
Returns
  • extension description

public SidewikiUserDescription getDescription ()

Returns the Sidewiki author description.

Returns
  • Sidewiki author description

public EntriesNumber getNumEntries ()

Returns the entries number.

Returns
  • entries number

public Rating getRating ()

Returns the user rating given by the user issued the request.

Returns
  • user rating given by the user issued the request

public ResourceId getResourceId ()

Returns the Sidewiki author id.

Returns
  • Sidewiki author id

public SidewikiThumbnail getThumbnail ()

Returns the user portrait thumbnail url.

Returns
  • user portrait thumbnail url

public boolean hasDescription ()

Returns whether it has the Sidewiki author description.

Returns
  • whether it has the Sidewiki author description

public boolean hasNumEntries ()

Returns whether it has the entries number.

Returns
  • whether it has the entries number

public boolean hasRating ()

Returns whether it has the user rating given by the user issued the request.

Returns
  • whether it has the user rating given by the user issued the request

public boolean hasResourceId ()

Returns whether it has the Sidewiki author id.

Returns
  • whether it has the Sidewiki author id

public boolean hasThumbnail ()

Returns whether it has the user portrait thumbnail url.

Returns
  • whether it has the user portrait thumbnail url

public void setDescription (SidewikiUserDescription description)

Sets the Sidewiki author description.

Parameters
description Sidewiki author description or null to reset

public void setNumEntries (EntriesNumber numEntries)

Sets the entries number.

Parameters
numEntries Entries number or null to reset

public void setRating (Rating rating)

Sets the user rating given by the user issued the request.

Parameters
rating User rating given by the user issued the request or null to reset

public void setResourceId (ResourceId resourceId)

Sets the Sidewiki author id.

Parameters
resourceId Sidewiki author id or null to reset

public void setThumbnail (SidewikiThumbnail thumbnail)

Sets the user portrait thumbnail url.

Parameters
thumbnail User portrait thumbnail url 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.