Author: ivol
Date: Mon Oct 11 09:34:52 2010
New Revision: 145
Log:
[AMDATU-78]
Small Javadoc improvements
Modified:
trunk/application-bundles/gadget-management/src/main/java/org/amdatu/application/gadgetmanagement/DefaultGadgetRepository.java
trunk/application-bundles/gadget-management/src/main/java/org/amdatu/application/gadgetmanagement/GadgetManagement.java
Modified:
trunk/application-bundles/gadget-management/src/main/java/org/amdatu/application/gadgetmanagement/DefaultGadgetRepository.java
==============================================================================
---
trunk/application-bundles/gadget-management/src/main/java/org/amdatu/application/gadgetmanagement/DefaultGadgetRepository.java
(original)
+++
trunk/application-bundles/gadget-management/src/main/java/org/amdatu/application/gadgetmanagement/DefaultGadgetRepository.java
Mon Oct 11 09:34:52 2010
@@ -16,14 +16,14 @@
*/
package org.amdatu.application.gadgetmanagement;
-
-
-
/**
- * List of default gadget URLs.
+ * This interface holds a list of all gadget URLs that are added to the Amdatu
gadget repository by default.
* @author ivol
*/
public interface DefaultGadgetRepository {
+ /**
+ * List of all default gadget URLs.
+ */
final static String[] DEFAULT_GADGETS = new String[] {
"http://www.heywhatsthat.com/mapplets/profiler.xml";, // Path profiler
"http://www.vertaalwoord.nl/google/vertaalwoord.xml";, // Vertalen
Woorden
Modified:
trunk/application-bundles/gadget-management/src/main/java/org/amdatu/application/gadgetmanagement/GadgetManagement.java
==============================================================================
---
trunk/application-bundles/gadget-management/src/main/java/org/amdatu/application/gadgetmanagement/GadgetManagement.java
(original)
+++
trunk/application-bundles/gadget-management/src/main/java/org/amdatu/application/gadgetmanagement/GadgetManagement.java
Mon Oct 11 09:34:52 2010
@@ -19,19 +19,20 @@
import org.amdatu.platform.shindig.application.GadgetCategory;
import org.amdatu.platform.shindig.application.GadgetDefinition;
-
/**
- * This service provides CRUD operations on all gadgets available in the
gadget store. The gadget
- * store is a storage of gadget definitions consisting of the URL of the
gadget, plus optional oAuth
- * keys and secrets. So the store in fact only stores references to gadgets,
the contents of the gadgets
- * is stored somewhere else (for example in a gadget bundle but it could also
be an external gadget)
+ * This service provides CRUD operations on all gadgets definitions available
in the gadget store. The gadget
+ * store provides the set of all gadgets that can be added to the dashboard
and holds basic gadget configurations
+ * like gadget URL and oAuth keys and secrets. The gadget definition is
represented by a GadgetDefinition, which
+ * is based as input/output parameters of the CRUD operations.
+ * Note that store in fact only stores references to gadgets, the actual
gadget configuration is off course
+ * managed by the gadget itself.
* @author ivol
*/
public interface GadgetManagement {
/**
- * Adds a gadget specified by the given URL to the gadget store.
- * @param gadgetUrl URL of the gadget to add
- * @param category The category of the gadget, used to categorize the
gadgets in the 'add gadget' popup
+ * Adds a gadget definition to the gadget store.
+ * @param gadget Gadget definition to add
+ * @return <code>true</code> if adding the gadget definition to the store
succeeded, <code>false</code> otherwise.
*/
boolean addGadget(GadgetDefinition gadget);
