Package org.exoplatform.social.core.space.spi

Interface SpaceApplicationHandler

All Superinterfaces:
org.exoplatform.container.component.ComponentPlugin
public interface SpaceApplicationHandler extends org.exoplatform.container.component.ComponentPlugin
Handler for working with space applications: install, activate, deactivate, uninstall...
Since:
Oct 17, 2008
Author:
dang.tung, hoatle (hoatlevan at gmail dot com)

  • Method Details

    • initApps

      void initApps(Space space, SpaceTemplate spaceTemplate) throws SpaceException
      Initializes home space applications and space applications.
      Parameters:
      space -
      spaceTemplate -
      Throws:
      SpaceException
      Since:
      1.2.0-GA

    • deInitApp

      void deInitApp(Space space) throws SpaceException
      De-initializes a space application.
      Parameters:
      space -
      Throws:
      SpaceException

    • installApplication

      void installApplication(Space space, String appId) throws SpaceException
      Installs an application to a space.
      Parameters:
      space -
      appId -
      Throws:
      SpaceException

    • activateApplication

      void activateApplication(Space space, String appId, String appName) throws SpaceException
      Activates an installed application in a space.
      Parameters:
      space -
      appId -
      Throws:
      SpaceException

    • deactiveApplication

      void deactiveApplication(Space space, String appId) throws SpaceException
      Deactivates an installed application in a space.
      Parameters:
      space -
      appId -
      Throws:
      SpaceException

    • removeApplication

      void removeApplication(Space space, String appId, String appName) throws SpaceException
      Removes an application in a space.
      Parameters:
      space -
      appId -
      Throws:
      SpaceException

    • removeApplications

      void removeApplications(Space space) throws SpaceException
      Remove all applications in a space.
      Parameters:
      space -
      Throws:
      SpaceException

    • getName

      String getName()
      Gets name.
      Specified by:
      getName in interface org.exoplatform.container.component.ComponentPlugin
      Returns:

    • moveApplication

      default void moveApplication(Space space, String appId, int transition) throws Exception
      Parameters:
      space - Space to change its location
      appId - application identifier
      transition - positive number to move up and negative number to move down
      Throws:
      Exception - when error saving moved node

    • restoreApplicationLayout

      default void restoreApplicationLayout(Space space, String appId) throws Exception
      Restores a page layout to its default associated to Space Template
      Parameters:
      space - Space to change its layout
      appId - Id of the installed application or can be 'home' to designate the space home page
      Throws:
      Exception - when error saving moved node