Interface IComponent

    • Method Detail

      • getId

        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

        String getDescription()
        Returns the component description.
        Returns:
        the component description.
        Since:
        7.1.0
      • getChannelId

        String getChannelId()
        Returns the identifier of the component channel.
        Returns:
        the identifier of the component channel.
        Since:
        7.1.0
      • getPublicFilesChannelId

        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

        String getSourcePath()
        Returns the component source path.
        Returns:
        the component source path.
        Since:
        7.1.0
      • getChecksum

        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

        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

        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