Component

java.lang.Object
- lumis.portal.deployment.Component

All Implemented Interfaces:

Serializable, IComponent
```
public class Component
extends Object
implements IComponent
```
Component implementation.

Since:

7.1.0

Version:

$Revision: 21880 $ $Date: 2018-09-21 20:07:19 +0000 (Fri, 21 Sep 2018) $

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Component()

Constructors
Constructor and Description
`Component()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getChannelId()` Returns the identifier of the component channel.
`String`	`getChecksum()` Returns the hexadecimal string MD5 checksum of this component. If this component belongs to an editable module (i.e.
`Node`	`getConstraints()` Returns the constraints.
`Date`	`getDeploymentDateTime()` Returns the date-time of the deployment of this module.
`String`	`getDeployMessage()` Returns a message of all errors and warnings occurred during deployment process.
`String`	`getDescription()` Returns the component description.
`String`	`getId()` Returns the component identifier.
`String`	`getLastUpgradeStepExecuted()` Returns the lastUpgradeStepExecuted.
`ComponentObject`	`getMetadata()` Returns this component's metadata.
`ComponentObject`	`getMetadataForComparing()` Returns the meta data that should be used for comparing this component (or its inner objects) to other one.
`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.
`String`	`getPublicFilesChannelId()` Returns the public files channel Id.
`String`	`getRawVersion()` Returns the rawVersion.
`Node`	`getReplace()` Returns the replace.
`String`	`getSourcePath()` Returns the component source path.
`ComponentStatus`	`getStatus()` Returns the component state.
`IVersion`	`getVersion()` Returns the component version.
`void`	`setChannelId(String channelId)` Sets the channelId.
`void`	`setChecksum(String checksum)` Sets the checksum.
`void`	`setConstraints(Node constraints)` Sets the constraints.
`void`	`setDeploymentDateTime(Date deploymentDateTime)` Sets the deploymentDateTime.
`void`	`setDeployMessage(String deployMessage)` Sets the deployMessage.
`void`	`setDescription(String description)` Sets the description.
`void`	`setId(String id)`
`void`	`setLastUpgradeStepExecuted(String lastUpgradeStepExecuted)` Sets the lastUpgradeStepExecuted.
`void`	`setNumErrors(int numErrors)` Sets the numErrors.
`void`	`setNumWarnings(int numWarnings)` Sets the numWarnings.
`void`	`setPublicFilesChannelId(String publicFilesChannelId)` Sets the publicFilesChannelId.
`void`	`setRawVersion(String rawVersion)` Sets the rawVersion.
`void`	`setReplace(Node replace)` Sets the replace.
`void`	`setSourcePath(String sourcePath)` Sets the sourcePath.
`void`	`setStatus(ComponentStatus status)` Sets the status.
`void`	`setVersion(IVersion version)` Sets the version.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Component
```
public Component()
```
- Method Detail
  - getId
```
public String getId()
```
    Description copied from interface: IComponent
    
    Returns the component identifier.
    
    Specified by:
    
    getId in interface IComponent
    
    Returns:
    
    the component identifier.
  - getVersion
```
public IVersion getVersion()
```
    Description copied from interface: IComponent
    
    Returns the component version.
    
    Specified by:
    
    getVersion in interface IComponent
    
    Returns:
    
    the component version.
  - getDescription
```
public String getDescription()
```
    Description copied from interface: IComponent
    
    Returns the component description.
    
    Specified by:
    
    getDescription in interface IComponent
    
    Returns:
    
    the component description.
  - getChannelId
```
public String getChannelId()
```
    Description copied from interface: IComponent
    
    Returns the identifier of the component channel.
    
    Specified by:
    
    getChannelId in interface IComponent
    
    Returns:
    
    the identifier of the component channel.
  - getPublicFilesChannelId
```
public String getPublicFilesChannelId()
```
    Description copied from interface: IComponent
    
    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.
    
    Specified by:
    
    getPublicFilesChannelId in interface IComponent
    
    Returns:
    
    the identifier of the channel to be used to calculate the website.
  - getSourcePath
```
public String getSourcePath()
```
    Description copied from interface: IComponent
    
    Returns the component source path.
    
    Specified by:
    
    getSourcePath in interface IComponent
    
    Returns:
    
    the component source path.
  - getChecksum
```
public String getChecksum()
```
    Description copied from interface: IComponent
    
    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.
    
    Specified by:
    
    getChecksum in interface IComponent
    
    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).
  - getStatus
```
public ComponentStatus getStatus()
```
    Description copied from interface: IComponent
    
    Returns the component state.
    
    Specified by:
    
    getStatus in interface IComponent
    
    Returns:
    
    the component state.
  - getDeployMessage
```
public String getDeployMessage()
```
    Description copied from interface: IComponent
    
    Returns a message of all errors and warnings occurred during deployment process.
    
    Specified by:
    
    getDeployMessage in interface IComponent
    
    Returns:
    
    a string.
  - getNumErrors
```
public int getNumErrors()
```
    Description copied from interface: IComponent
    
    Returns the amount of errors in the last deployment operation over the module.
    
    Specified by:
    
    getNumErrors in interface IComponent
    
    Returns:
    
    the amount of errors.
  - getNumWarnings
```
public int getNumWarnings()
```
    Description copied from interface: IComponent
    
    Returns the amount of warnings in the last deployment operation over the module.
    
    Specified by:
    
    getNumWarnings in interface IComponent
    
    Returns:
    
    the amount of warnings.
  - getDeploymentDateTime
```
public Date getDeploymentDateTime()
```
    Description copied from interface: IComponent
    
    Returns the date-time of the deployment of this module.
    
    Specified by:
    
    getDeploymentDateTime in interface IComponent
    
    Returns:
    
    the date-time of the deployment of this module.
  - setId
```
public void setId(String id)
```
  - setDescription
```
public void setDescription(String description)
```
    Sets the description.
    
    Parameters:
    
    description - the description value to set.
    
    Since:
    
    7.1.0
  - getRawVersion
```
public String getRawVersion()
```
    Returns the rawVersion.
    
    Returns:
    
    the rawVersion
    
    Since:
    
    7.1.0
  - setRawVersion
```
public void setRawVersion(String rawVersion)
```
    Sets the rawVersion.
    
    Parameters:
    
    rawVersion - the rawVersion value to set.
    
    Since:
    
    7.1.0
  - setVersion
```
public void setVersion(IVersion version)
```
    Sets the version.
    
    Parameters:
    
    version - the version value to set.
    
    Since:
    
    7.1.0
  - setChannelId
```
public void setChannelId(String channelId)
```
    Sets the channelId.
    
    Parameters:
    
    channelId - the channelId value to set.
    
    Since:
    
    7.1.0
  - setPublicFilesChannelId
```
public void setPublicFilesChannelId(String publicFilesChannelId)
```
    Sets the publicFilesChannelId.
    
    Parameters:
    
    publicFilesChannelId - the public files channelId value to set.
    
    Since:
    
    11.0.0
  - setSourcePath
```
public void setSourcePath(String sourcePath)
```
    Sets the sourcePath.
    
    Parameters:
    
    sourcePath - the sourcePath value to set.
    
    Since:
    
    7.1.0
  - setChecksum
```
public void setChecksum(String checksum)
```
    Sets the checksum.
    
    Parameters:
    
    checksum - the checksum value to set.
    
    Since:
    
    7.1.0
  - setStatus
```
public void setStatus(ComponentStatus status)
```
    Sets the status.
    
    Parameters:
    
    status - the status value to set.
    
    Since:
    
    7.1.0
  - setNumErrors
```
public void setNumErrors(int numErrors)
```
    Sets the numErrors.
    
    Parameters:
    
    numErrors - the numErrors value to set.
    
    Since:
    
    7.1.0
  - setNumWarnings
```
public void setNumWarnings(int numWarnings)
```
    Sets the numWarnings.
    
    Parameters:
    
    numWarnings - the numWarnings value to set.
    
    Since:
    
    7.1.0
  - setDeployMessage
```
public void setDeployMessage(String deployMessage)
```
    Sets the deployMessage.
    
    Parameters:
    
    deployMessage - the deployMessage value to set.
    
    Since:
    
    7.1.0
  - setDeploymentDateTime
```
public void setDeploymentDateTime(Date deploymentDateTime)
```
    Sets the deploymentDateTime.
    
    Parameters:
    
    deploymentDateTime - the deploymentDateTime value to set.
    
    Since:
    
    7.1.0
  - getConstraints
```
public Node getConstraints()
```
    Returns the constraints.
    
    Returns:
    
    the constraints
    
    Since:
    
    7.1.0
  - setConstraints
```
public void setConstraints(Node constraints)
```
    Sets the constraints.
    
    Parameters:
    
    constraints - the constraints value to set.
    
    Since:
    
    7.1.0
  - getReplace
```
public Node getReplace()
```
    Returns the replace.
    
    Returns:
    
    the replace
    
    Since:
    
    7.1.0
  - setReplace
```
public void setReplace(Node replace)
```
    Sets the replace.
    
    Parameters:
    
    replace - the replace value to set.
    
    Since:
    
    7.1.0
  - getModule
```
public IModule getModule()
```
    Description copied from interface: IComponent
    
    Returns the owner module of the component.
    
    Specified by:
    
    getModule in interface IComponent
    
    Returns:
    
    the owner module of the component.
  - getLastUpgradeStepExecuted
```
public String getLastUpgradeStepExecuted()
```
    Returns the lastUpgradeStepExecuted.
    
    Returns:
    
    the lastUpgradeStepExecuted
    
    Since:
    
    7.1.0
  - setLastUpgradeStepExecuted
```
public void setLastUpgradeStepExecuted(String lastUpgradeStepExecuted)
```
    Sets the lastUpgradeStepExecuted.
    
    Parameters:
    
    lastUpgradeStepExecuted - the lastUpgradeStepExecuted value to set.
    
    Since:
    
    7.1.0
  - getMetadata
```
public ComponentObject getMetadata()
```
    Returns this component's metadata.
    
    Returns:
    
    this component's metadata.
    
    Since:
    
    8.1.0
  - getMetadataForComparing
```
public ComponentObject getMetadataForComparing()
                                        throws PortalException
```
    Returns the meta data that should be used for comparing this component (or its inner objects) to other one.
    
    Returns:
    
    the meta data that should be used for comparing this component (or its inner objects) to other one.
    
    Throws:
    
    PortalException
    
    Since:
    
    10.4.0
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Component

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Component

Method Detail

getId

getVersion

getDescription

getChannelId

getPublicFilesChannelId

getSourcePath

getChecksum

getStatus

getDeployMessage

getNumErrors

getNumWarnings

getDeploymentDateTime

setId

setDescription

getRawVersion

setRawVersion

setVersion

setChannelId

setPublicFilesChannelId

setSourcePath

setChecksum

setStatus

setNumErrors

setNumWarnings

setDeployMessage

setDeploymentDateTime

getConstraints

setConstraints

getReplace

setReplace

getModule

getLastUpgradeStepExecuted

setLastUpgradeStepExecuted

getMetadata

getMetadataForComparing

toString