Interface ISystemMechanics

All Superinterfaces:
IComponent, IInitializable, IMechanics, ISystemHandler

public interface ISystemMechanics extends IMechanics
Some system type mechanics
  • Field Details

    • IMPORT_CORE_COMPONENTS_STATE

      static final int IMPORT_CORE_COMPONENTS_STATE
      See Also:
  • Method Details

    • importCoreComponents

      List<IComponent> importCoreComponents(IComponentProvider componentProvider, IThingID userId, String configLocation) throws PortalException
      This will import any components defined in an existing location for a specific provider.
      Parameters:
      componentProvider - the IComponentProvider
      userId - the current user
      configLocation - optional - the location to find the config files...
      Returns:
      a list of all imported IComponents
      Throws:
      PortalException
    • computeDependenciesFromXMLImport

      List<String> computeDependenciesFromXMLImport(String xmlLocation) throws PortalException
      Returns a list of strings specifying the xtypes required in order to import the xml
      Parameters:
      xmlLocation - the location of the xml file
      Throws:
      PortalException
      See Also:
      • XMLImport
    • computeDependenciesFromXMLImport

      List<String> computeDependenciesFromXMLImport(String xmlLocation, IDependencyFileLocator dependencyFileLocator) throws PortalException
      Returns a list of strings specifying the xtypes required in order to import the xml
      Parameters:
      xmlLocation - the location of the xml file
      Throws:
      PortalException
      See Also:
      • XMLImport
    • fireSystemPropertyEvent

      void fireSystemPropertyEvent(String key, String oldValue, String value) throws PortalException
      Fires an System Property event.
      Parameters:
      key - the name of the system property
      oldValue - the previous value
      value - the new value
      Throws:
      PortalException - if the userId is invalid.