Package ru.cg.webbpm.studio.subsystems.page_designer.serialization.api

Interface ComponentManager

All Known Implementing Classes:
ComponentManagerImpl
public interface ComponentManager
Author:
Abdulin Ildar

  • Method Details

    • componentFileName

      static String componentFileName(String componentName)

    • componentsLoaded

      boolean componentsLoaded()

    • getComponents

      Collection<Component> getComponents()

    • getComponent

      Component getComponent(String id)
      Returns component by its id, or id of the object
      Parameters:
      id - component id, or id of an object in component
      Returns:
      component with specified id or containing specified object, or null if no component found

    • getComponent

      Component getComponent(Path path)

    • getComponentObject

      PageObject getComponentObject(String objectId)
      Looks for page object with given ID in all components, and returns it if found, or else null
      Parameters:
      objectId - target object id
      Returns:
      wrapped page object, or null if not found

    • getComponentId

      String getComponentId(Path path)

    • getComponentPath

      Path getComponentPath(String objectId)
      Returns path to a component file containing component or an object with specified id.
      Parameters:
      objectId - id of an object / component
      Returns:
      path to component, null if not found

    • getPackage

      Optional<Package> getPackage(String objectId)
      Returns a package containing an object with specified id, if any
      Parameters:
      objectId - object id or component id
      Returns:
      the package if it exists

    • getComponentObjectName

      String getComponentObjectName(String componentId)

    • createComponent

      Component createComponent(Path path)

    • createComponent

      Component createComponent(Path path, PageObject rootObject)

    • createComponent

      Path createComponent(String name)

    • save

      void save(Component component, Path path)

    • findPagesWithComponents

      Set<Path> findPagesWithComponents(Set<Component> components)

    • getDependantComponentIds

      List<String> getDependantComponentIds(Component component)

    • getDependantCompOverrideIds

      List<String> getDependantCompOverrideIds(Component component)

    • findAndSaveDependantComponents

      Set<Component> findAndSaveDependantComponents(Component component, Path path)

    • getComponentsPackageDescriptor

      ComponentsPackage getComponentsPackageDescriptor()

    • getComponentCategory

      String getComponentCategory(Component component)

    • getComponentLocalization

      Optional<Path> getComponentLocalization(Component component)

    • getComponentIcon

      Optional<Path> getComponentIcon(Component component)

    • getComponentDocumentation

      Optional<String> getComponentDocumentation(Component component)

    • getComponentDocumentation

      Optional<String> getComponentDocumentation(Component component, Supplier<String> doesNotExistMessageProvider)

    • getComponentsPackage

      ComponentsPackage getComponentsPackage()

    • isProjectComponent

      boolean isProjectComponent(Path path)
      Checks if a component represented by path belong to project
      Parameters:
      path - absolute path to component file
      Returns:
      true if component belongs to project