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

All Known Implementing Classes:

GadgetServiceImpl

public interface GadgetService

Method Summary

GadgetDeclaration	getGadget(java.lang.String gadgetSymbolicName) Return a gadget declaration
java.util.List<java.lang.String>	getGadgetCategory() Returns the list of gadget categories
java.net.URL	getGadgetDefinition(java.lang.String gadgetName) Returns a URL to the gadget definition
java.util.List<GadgetDeclaration>	getGadgetList() Returns the list of all registered gadgets declarations
java.util.List<GadgetDeclaration>	getGadgetList(java.lang.String category) Returns the list of the registered gadgets for a given category
java.util.Map<java.lang.String,java.util.ArrayList<java.lang.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)
java.io.InputStream	getGadgetResource(java.lang.String gadgetName, java.lang.String resourcePath) Returns a stream on a resource of a gadget
java.lang.String	getIconUrl(java.lang.String gadgetName) Returns a relative URL to the gadget icon

Method Detail

getGadget

GadgetDeclaration getGadget(java.lang.String gadgetSymbolicName)

Return a gadget declaration

Parameters:

gadgetSymbolicName - the symbolic name of the gadget

getGadgetList

java.util.List<GadgetDeclaration> getGadgetList()

Returns the list of all registered gadgets declarations

getGadgetCategory

java.util.List<java.lang.String> getGadgetCategory()

Returns the list of gadget categories

getGadgetList

java.util.List<GadgetDeclaration> getGadgetList(java.lang.String category)

Returns the list of the registered gadgets for a given category

Parameters:

category - the category

getGadgetNameByCategory

java.util.Map<java.lang.String,java.util.ArrayList<java.lang.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

java.io.InputStream getGadgetResource(java.lang.String gadgetName,
                                      java.lang.String resourcePath)
                                      throws java.io.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:

java.io.IOException

getGadgetDefinition

java.net.URL getGadgetDefinition(java.lang.String gadgetName)

Returns a URL to the gadget definition

Parameters:

gadgetName - the gadget symbolic name

getIconUrl

java.lang.String getIconUrl(java.lang.String gadgetName)

Returns a relative URL to the gadget icon

Parameters:

gadgetName - the gadget symbolic name