public class

OpenSearchDescriptionDocument

extends ExtensionPoint
java.lang.Object
   ↳ com.google.gdata.data.AbstractExtension
     ↳ com.google.gdata.data.ExtensionPoint
       ↳ com.google.gdata.data.OpenSearchDescriptionDocument

Class Overview

OpenSearch description document. See http://opensearch.a9.com/ for more information.

Summary

Nested Classes
class OpenSearchDescriptionDocument.Handler XmlParser ElementHandler for openSearchDesc:OpenSearchDescription  
class OpenSearchDescriptionDocument.SyndicationRight The SyndicationRight class defines constant values for syndication rights types. 
Fields
protected boolean adultContent A boolean flag that must be set if the content provided is not suitable for minors.
protected String attribution A list of all content sources or platforms that should be credited.
protected String contact An email address at which the developer can be reached.
protected String description A human readable text description of the search content provider.
protected String developer The developer or maintainer of the OpenSearch feed.
protected String format The XML schema used by the search engine specified by url.
protected String image A URL that identifies the location of a 64x64-pixel image that can be used in association with this search engine.
protected String longName The name by which this search content provider is referred to in hypertext links, etc.
protected String sampleSearch A search string that should be used when example searches are done against this OpenSearch engine.
protected String shortName A brief name that will appear in UI elements that reference this search content provider.
protected int syndicationRight The degree to which the search results provided by this search engine can be distributed.
protected String tags A space-delimited set of words that are used as keywords to identify and categorize this search content.
protected String url The HTTP GET URL at which the search content can be found.
[Expand]
Inherited Fields
From class com.google.gdata.data.ExtensionPoint
From class com.google.gdata.data.AbstractExtension
Public Constructors
OpenSearchDescriptionDocument()
OpenSearchDescriptionDocument(OpenSearchDescriptionDocument doc)
Public Methods
void generate(XmlWriter w)
Generates XML.
final boolean getAdultContent()
final String getAttribution()
final String getContact()
final String getDescription()
final String getDeveloper()
final String getFormat()
final String getImage()
final String getLongName()
final String getSampleSearch()
final String getShortName()
final int getSyndicationRight()
final String getTags()
final String getUrl()
void parse(ExtensionProfile extProfile, Reader reader)
Parses XML.
void setAdultContent(boolean v)
void setAttribution(String v)
void setContact(String v)
void setDescription(String v)
void setDeveloper(String v)
void setFormat(String v)
void setImage(String v)
void setLongName(String v)
void setSampleSearch(String v)
void setShortName(String v)
void setSyndicationRight(int v)
void setTags(String v)
void setUrl(String v)
void validateConfiguration()
Validates that the OpenSearchDescriptionDocument has all required properties.
[Expand]
Inherited Methods
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

Fields

protected boolean adultContent

A boolean flag that must be set if the content provided is not suitable for minors.

protected String attribution

A list of all content sources or platforms that should be credited.

protected String contact

An email address at which the developer can be reached.

protected String description

A human readable text description of the search content provider.

protected String developer

The developer or maintainer of the OpenSearch feed.

protected String format

The XML schema used by the search engine specified by url.

protected String image

A URL that identifies the location of a 64x64-pixel image that can be used in association with this search engine.

protected String longName

The name by which this search content provider is referred to in hypertext links, etc.

protected String sampleSearch

A search string that should be used when example searches are done against this OpenSearch engine.

protected String shortName

A brief name that will appear in UI elements that reference this search content provider.

protected int syndicationRight

The degree to which the search results provided by this search engine can be distributed.

protected String tags

A space-delimited set of words that are used as keywords to identify and categorize this search content.

protected String url

The HTTP GET URL at which the search content can be found.

Public Constructors

public OpenSearchDescriptionDocument ()

public OpenSearchDescriptionDocument (OpenSearchDescriptionDocument doc)

Parameters
doc

Public Methods

public void generate (XmlWriter w)

Generates XML.

Parameters
w Output writer
Throws
IOException

public final boolean getAdultContent ()

public final String getAttribution ()

public final String getContact ()

public final String getDescription ()

public final String getDeveloper ()

public final String getFormat ()

public final String getImage ()

public final String getLongName ()

public final String getSampleSearch ()

public final String getShortName ()

public final int getSyndicationRight ()

public final String getTags ()

public final String getUrl ()

public void parse (ExtensionProfile extProfile, Reader reader)

Parses XML.

Parameters
extProfile Extension profile
reader XML input stream
Throws
ParseException
IOException

public void setAdultContent (boolean v)

Parameters
v

public void setAttribution (String v)

Parameters
v

public void setContact (String v)

Parameters
v

public void setDescription (String v)

Parameters
v

public void setDeveloper (String v)

Parameters
v

public void setFormat (String v)

Parameters
v

public void setImage (String v)

Parameters
v

public void setLongName (String v)

Parameters
v

public void setSampleSearch (String v)

Parameters
v

public void setShortName (String v)

Parameters
v

public void setSyndicationRight (int v)

Parameters
v

public void setTags (String v)

Parameters
v

public void setUrl (String v)

Parameters
v

public void validateConfiguration ()

Validates that the OpenSearchDescriptionDocument has all required properties. The one exception is the url property, which is dynamically generated based upon the feed that is queried.

Throws
ServiceConfigurationException