Nuxeo Enterprise Platform 5.4

org.nuxeo.opensocial.container.client.service.api
Interface ContainerService

All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
All Known Implementing Classes:
ContainerServiceImpl

@RemoteServiceRelativePath(value="gwtcontainer")
public interface ContainerService
extends com.google.gwt.user.client.rpc.RemoteService

ContainerService

Author:
Guillaume Cusnieux

Method Summary
 GadgetBean addGadget(java.lang.String gadgetName, java.util.Map<java.lang.String,java.lang.String> gwtParams)
          Adds a gadget.
 Container getContainer(java.util.Map<java.lang.String,java.lang.String> gwtParams)
          Retrieves a specific container.
 java.util.Map<java.lang.String,java.util.ArrayList<java.lang.String>> getGadgetList(java.util.Map<java.lang.String,java.lang.String> gwtParams)
          Gets collection of gadget name sorted by category.
 GadgetBean removeGadget(GadgetBean gadget, java.util.Map<java.lang.String,java.lang.String> gwtParams)
          Removes gadget.
 GadgetBean saveGadget(GadgetBean gadget, java.util.Map<java.lang.String,java.lang.String> gwtParams)
          Saves a Gadget.
 GadgetBean saveGadgetPreferences(GadgetBean gadget, java.lang.String form, java.util.Map<java.lang.String,java.lang.String> gwtParams)
          Saves preferences of gadget with form parameter.
 java.lang.Boolean saveGadgetsCollection(java.util.Collection<GadgetBean> beans, java.util.Map<java.lang.String,java.lang.String> gwtParams)
          Saves a collection of gadget
 Container saveLayout(java.util.Map<java.lang.String,java.lang.String> gwtParams, java.lang.String layout)
          Saves layout of container.
 

Method Detail

getContainer

Container getContainer(java.util.Map<java.lang.String,java.lang.String> gwtParams)
                       throws ContainerServiceException
Retrieves a specific container.

Throws:
ContainerServiceException

saveLayout

Container saveLayout(java.util.Map<java.lang.String,java.lang.String> gwtParams,
                     java.lang.String layout)
                     throws ContainerServiceException
Saves layout of container.

Throws:
ContainerServiceException

saveGadgetPreferences

GadgetBean saveGadgetPreferences(GadgetBean gadget,
                                 java.lang.String form,
                                 java.util.Map<java.lang.String,java.lang.String> gwtParams)
                                 throws ContainerServiceException
Saves preferences of gadget with form parameter.

Parameters:
gadget -
form - new preferences
gwtParams -
Throws:
ContainerServiceException

removeGadget

GadgetBean removeGadget(GadgetBean gadget,
                        java.util.Map<java.lang.String,java.lang.String> gwtParams)
                        throws ContainerServiceException
Removes gadget.

Returns:
the removed GadgetBean
Throws:
ContainerServiceException

addGadget

GadgetBean addGadget(java.lang.String gadgetName,
                     java.util.Map<java.lang.String,java.lang.String> gwtParams)
                     throws ContainerServiceException
Adds a gadget.

Returns:
the added GadgetBean
Throws:
ContainerServiceException

saveGadgetsCollection

java.lang.Boolean saveGadgetsCollection(java.util.Collection<GadgetBean> beans,
                                        java.util.Map<java.lang.String,java.lang.String> gwtParams)
                                        throws ContainerServiceException
Saves a collection of gadget

Throws:
ContainerServiceException

getGadgetList

java.util.Map<java.lang.String,java.util.ArrayList<java.lang.String>> getGadgetList(java.util.Map<java.lang.String,java.lang.String> gwtParams)
                                                                                    throws ContainerServiceException
Gets collection of gadget name sorted by category.

Returns:
a map whose key are the categories and values are lists of gadget name
Throws:
ContainerServiceException

saveGadget

GadgetBean saveGadget(GadgetBean gadget,
                      java.util.Map<java.lang.String,java.lang.String> gwtParams)
                      throws ContainerServiceException
Saves a Gadget.

Returns:
the saved gadget bean
Throws:
ContainerServiceException

Nuxeo Enterprise Platform 5.4

Copyright © 2010 Nuxeo SAS. All Rights Reserved.