Package lumis.portal.deployment

Interface IComponent

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    Component
    @StableMinor(version="16.0",
             sinceVersion="7.1")
public interface IComponent
extends java.io.Serializable
    LumisXP component.
    Since:
    7.1.0
    Version:
    $Revision: 25808 $ $Date: 2023-07-04 15:20:55 -0300 (Tue, 04 Jul 2023) $

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getChannelId()
      Returns the identifier of the component channel.
      java.lang.String getChecksum()
      Returns the hexadecimal string MD5 checksum of this component.
      If this component belongs to an editable module (i.e.
      java.util.Date getDeploymentDateTime()
      Returns the date-time of the deployment of this module.
      java.lang.String getDeployMessage()
      Returns a message of all errors and warnings occurred during deployment process.
      java.lang.String getDescription()
      Returns the component description.
      java.lang.String getId()
      Returns the component identifier.
      IModule getModule()
      Returns the owner module of the component.
      int getNumErrors()
      Returns the amount of errors in the last deployment operation over the module.
      int getNumWarnings()
      Returns the amount of warnings in the last deployment operation over the module.
      java.lang.String getPublicFilesChannelId()
      Returns the public files channel Id.
      java.lang.String getSourcePath()
      Returns the component source path.
      ComponentStatus getStatus()
      Returns the component state.
      IVersion getVersion()
      Returns the component version.

    • Method Detail

      • getId

        java.lang.String getId()
        Returns the component identifier.
        Returns:
        the component identifier.
        Since:
        7.1.0

      • getVersion

        IVersion getVersion()
        Returns the component version.
        Returns:
        the component version.
        Since:
        7.1.0

      • getDescription

        java.lang.String getDescription()
        Returns the component description.
        Returns:
        the component description.
        Since:
        7.1.0

      • getChannelId

        java.lang.String getChannelId()
        Returns the identifier of the component channel.
        Returns:
        the identifier of the component channel.
        Since:
        7.1.0

      • getPublicFilesChannelId

        java.lang.String getPublicFilesChannelId()
        Returns the public files channel Id. This attribute indicates what channel to use to identify the website directory to which the public files of this component should be copied to. If not specified public files of this component will be copied to all registered website directories.
        Returns:
        the identifier of the channel to be used to calculate the website.
        Since:
        11.0.0

      • getSourcePath

        java.lang.String getSourcePath()
        Returns the component source path.
        Returns:
        the component source path.
        Since:
        7.1.0

      • getChecksum

        java.lang.String getChecksum()
        Returns the hexadecimal string MD5 checksum of this component.
        If this component belongs to an editable module (i.e. IModule.getSourceDir() is not null), the checksum will always be null.
        Returns:
        the hexadecimal string MD5 checksum of this component or null if this component belongs to an editable module (i.e. IModule.getSourceDir() is not null).
        Since:
        7.1.0

      • getStatus

        ComponentStatus getStatus()
        Returns the component state.
        Returns:
        the component state.
        Since:
        7.1.0

      • getDeployMessage

        java.lang.String getDeployMessage()
        Returns a message of all errors and warnings occurred during deployment process.
        Returns:
        a string.
        Since:
        7.1.0

      • getNumErrors

        int getNumErrors()
        Returns the amount of errors in the last deployment operation over the module.
        Returns:
        the amount of errors.
        Since:
        7.1.0

      • getNumWarnings

        int getNumWarnings()
        Returns the amount of warnings in the last deployment operation over the module.
        Returns:
        the amount of warnings.
        Since:
        7.1.0

      • getDeploymentDateTime

        java.util.Date getDeploymentDateTime()
        Returns the date-time of the deployment of this module.
        Returns:
        the date-time of the deployment of this module.
        Since:
        7.1.0

      • getModule

        IModule getModule()
        Returns the owner module of the component.
        Returns:
        the owner module of the component.
        Since:
        7.1.0