org.nuxeo.opensocial.gadgets.service.api

Interface GadgetDeclaration

All Known Implementing Classes:

BaseGadgetDescriptor, ExternalGadgetDescriptor, InternalGadgetDescriptor

public interface GadgetDeclaration

This is how code outside of the gadget implementation sees the gadget. The implementation can be an internal or external gadget. Callers should not depend on particular implementation strategies since they may vary quite widely.

Author:

Ian Smith, Thomas Roger

Method Summary

Methods

Modifier and Type	Method and Description
String	getAuthor()
String	getCategory()
String	getDescription()
String	getDescription(Locale locale) Try to find an localized description for this gadet
boolean	getDisabled()
URL	getGadgetDefinition()
org.apache.shindig.gadgets.spec.GadgetSpec	getGadgetSpec()
String	getIconUrl()
String	getName()
String	getPublicGadgetDefinition() Returns the public URL of the gadget spec.
URL	getResource(String resourcePath)
InputStream	getResourceAsStream(String resourcePath)
String	getScreenshot()
String	getThumbnail()
String	getTitle()
String	getTitle(Locale locale) Try to find an internationalized title for this gadget.
boolean	isExternal()

Method Detail

getName

String getName()

getDisabled

boolean getDisabled()

getCategory

String getCategory()

getIconUrl

String getIconUrl()

getResourceAsStream

InputStream getResourceAsStream(String resourcePath)
                                throws IOException

Throws:

IOException

getGadgetDefinition

URL getGadgetDefinition()
                        throws MalformedURLException

Throws:

MalformedURLException

getPublicGadgetDefinition

String getPublicGadgetDefinition()
                                 throws MalformedURLException

Returns the public URL of the gadget spec. That URL can be used to add the gadget in an other container.

Throws:

MalformedURLException

Since:

5.4.2

isExternal

boolean isExternal()

getDescription

String getDescription()

getGadgetSpec

org.apache.shindig.gadgets.spec.GadgetSpec getGadgetSpec()

getTitle

String getTitle()

getTitle

String getTitle(Locale locale)

Try to find an internationalized title for this gadget.

The label key is "label.gadget." + gadgetName.

Since:

5.5

getDescription

String getDescription(Locale locale)

Try to find an localized description for this gadet

The label key is "label.gadget." + gadgetName + ".description"

Since:

5.8

getAuthor

String getAuthor()

getScreenshot

String getScreenshot()

getThumbnail

String getThumbnail()

getResource

URL getResource(String resourcePath)
                throws IOException

Throws:

IOException