org.nuxeo.opensocial.gadgets.service.api
Interface GadgetService

All Known Implementing Classes:

GadgetServiceImpl

public interface GadgetService

Method Summary

GadgetDeclaration	getGadget(String gadgetSymbolicName) Return a gadget declaration
List<String>	getGadgetCategory() Returns the list of gadget categories
URL	getGadgetDefinition(String gadgetName) Returns a URL to the gadget definition
List<GadgetDeclaration>	getGadgetList() Returns the list of all registered gadgets declarations
List<GadgetDeclaration>	getGadgetList(String category) Returns the list of the registered gadgets for a given category
Map<String,ArrayList<String>>	getGadgetNameByCategory() Return a hashed map of all registered gadgets by category TODO: check if this is necessary in the API (perhaps a GWT tweak)
InputStream	getGadgetResource(String gadgetName, String resourcePath) Returns a stream on a resource of a gadget
String	getIconUrl(String gadgetName) Returns a relative URL to the gadget icon

Method Detail

getGadget

GadgetDeclaration getGadget(String gadgetSymbolicName)

Return a gadget declaration

Parameters:

gadgetSymbolicName - the symbolic name of the gadget

getGadgetList

List<GadgetDeclaration> getGadgetList()

Returns the list of all registered gadgets declarations

getGadgetCategory

List<String> getGadgetCategory()

Returns the list of gadget categories

getGadgetList

List<GadgetDeclaration> getGadgetList(String category)

Returns the list of the registered gadgets for a given category

Parameters:

category - the category

getGadgetNameByCategory

Map<String,ArrayList<String>> getGadgetNameByCategory()

Return a hashed map of all registered gadgets by category TODO: check if this is necessary in the API (perhaps a GWT tweak)

getGadgetResource

InputStream getGadgetResource(String gadgetName,
                              String resourcePath)
                              throws IOException

Returns a stream on a resource of a gadget

Parameters:

gadgetName - the symbolic name of the gadget

resourcePath - the relative path to the resources

Throws:

IOException

getGadgetDefinition

URL getGadgetDefinition(String gadgetName)

Returns a URL to the gadget definition

Parameters:

gadgetName - the gadget symbolic name

getIconUrl

String getIconUrl(String gadgetName)

Returns a relative URL to the gadget icon

Parameters:

gadgetName - the gadget symbolic name