java.lang.Object
- com.zerog.ia.auto.project.ProjectObject
- - com.zerog.ia.auto.project.InstallableObject
  - - com.zerog.ia.auto.project.ComponentDependency

All Implemented Interfaces:

Referenceable
```
public final class ComponentDependency
extends InstallableObject
```
Defines the component dependency settings, which is used by a Component to determine whether a dependency component is installed on the target system or not.
ComponentDependency also defines the dependency check result variables.

See Also:

Component

Constructor Summary

Constructors
Constructor Description

ComponentDependency()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`getCheckVersionAtLeast()`	Whether or not the dependency check should consider a minimum component version.
`boolean`	`getCheckVersionAtMost()`	Whether or not the dependency check should consider a maximum component version.
`java.lang.String`	`getDependencyFailedMessage()`	The message to display when the component dependency check fails.
`java.lang.String`	`getDependencyFailedResultVariable()`	The variable where to store the component dependency check result.
`java.lang.String`	`getKeyFile()`	The key file location to match.
`boolean`	`getMatchesKeyFile()`	Whether or not the dependency check should match the key file location.
`java.lang.String`	`getMatchingKeyFileResultVariable()`	The variable where to store the key file location check result.
`Component`	`getParentComponent()`	The parent component which this component dependency is belongs to.
`ComponentVersion`	`getVersionAtLeast()`	The minimum component version to consider.
`ComponentVersion`	`getVersionAtMost()`	The maximum component version to consider.
`void`	`setCheckVersionAtLeast(boolean checksLowerBound)`	Whether or not the dependency check should consider a minimum component version.
`void`	`setCheckVersionAtMost(boolean checksUpperBound)`	Whether or not the dependency check should consider a maximum component version.
`void`	`setDependencyFailedMessage(java.lang.String dependencyFailedMessage)`	The message to display when the component dependency check fails.
`void`	`setDependencyFailedResultVariable(java.lang.String dependencyFailedResultVariable)`	The variable where to store the component dependency check result.
`void`	`setKeyFile(java.lang.String keyFile)`	The key file location to match.
`void`	`setMatchesKeyFile(boolean matchesKeyFile)`	Whether or not the dependency check should match the key file location.
`void`	`setMatchingKeyFileResultVariable(java.lang.String matchingKeyFileReturnVariable)`	The variable where to store the key file location check result.
`void`	`setParentComponent(Component component)`	The parent component which this component dependency is belongs to.
`void`	`setVersionAtLeast(ComponentVersion lowerBoundComponentVersion)`	The minimum component version to consider.
`void`	`setVersionAtMost(ComponentVersion upperBoundComponentVersion)`	The maximum component version to consider.

Methods inherited from class com.zerog.ia.auto.project.InstallableObject
getBelongsToUninstallPhase, getRollbackEnabledCancel, getRollbackEnabledError, getRuleExpression, getRules, getRulesLogicalOperation, getTagsInInstallPiece, setBelongsToUninstallPhase, setRollbackEnabledCancel, setRollbackEnabledError, setRuleExpression, setRulesLogicalOperation, setTagsInInstallPiece

Methods inherited from class com.zerog.ia.auto.project.ProjectObject
equals, getReferenceID, hashCode, setReferenceID

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ComponentDependency
```
public ComponentDependency()
```
- Method Detail
  - setMatchesKeyFile
```
public void setMatchesKeyFile(boolean matchesKeyFile)
```
    Whether or not the dependency check should match the key file location.
    
    See Also:
    
    setKeyFile(String)
  - getMatchesKeyFile
```
public boolean getMatchesKeyFile()
```
    Whether or not the dependency check should match the key file location.
    
    See Also:
    
    getKeyFile()
  - setKeyFile
```
public void setKeyFile(java.lang.String keyFile)
```
    The key file location to match. This is only used if the matchesKeyFile property is set to true.
  - getKeyFile
```
public java.lang.String getKeyFile()
```
    The key file location to match. This is only used if the matchesKeyFile property is set to true.
  - setMatchingKeyFileResultVariable
```
public void setMatchingKeyFileResultVariable(java.lang.String matchingKeyFileReturnVariable)
```
    The variable where to store the key file location check result. This variable will contain where the dependency is installed.
  - getMatchingKeyFileResultVariable
```
public java.lang.String getMatchingKeyFileResultVariable()
```
    The variable where to store the key file location check result. This variable will contain where the dependency is installed.
  - setCheckVersionAtLeast
```
public void setCheckVersionAtLeast(boolean checksLowerBound)
```
    Whether or not the dependency check should consider a minimum component version.
  - getCheckVersionAtLeast
```
public boolean getCheckVersionAtLeast()
```
    Whether or not the dependency check should consider a minimum component version.
  - setCheckVersionAtMost
```
public void setCheckVersionAtMost(boolean checksUpperBound)
```
    Whether or not the dependency check should consider a maximum component version.
  - getCheckVersionAtMost
```
public boolean getCheckVersionAtMost()
```
    Whether or not the dependency check should consider a maximum component version.
  - setVersionAtMost
```
public void setVersionAtMost(ComponentVersion upperBoundComponentVersion)
```
    The maximum component version to consider.
    
    See Also:
    
    setCheckVersionAtMost(boolean)
  - getVersionAtMost
```
public ComponentVersion getVersionAtMost()
```
    The maximum component version to consider.
    
    See Also:
    
    getCheckVersionAtMost()
  - setVersionAtLeast
```
public void setVersionAtLeast(ComponentVersion lowerBoundComponentVersion)
```
    The minimum component version to consider.
    
    See Also:
    
    setCheckVersionAtLeast(boolean)
  - getVersionAtLeast
```
public ComponentVersion getVersionAtLeast()
```
    The minimum component version to consider.
    
    See Also:
    
    getCheckVersionAtLeast()
  - setParentComponent
```
public void setParentComponent(Component component)
```
    The parent component which this component dependency is belongs to.
  - getParentComponent
```
public Component getParentComponent()
```
    The parent component which this component dependency is belongs to.
  - setDependencyFailedMessage
```
public void setDependencyFailedMessage(java.lang.String dependencyFailedMessage)
```
    The message to display when the component dependency check fails.
  - getDependencyFailedMessage
```
public java.lang.String getDependencyFailedMessage()
```
    The message to display when the component dependency check fails.
  - setDependencyFailedResultVariable
```
public void setDependencyFailedResultVariable(java.lang.String dependencyFailedResultVariable)
```
    The variable where to store the component dependency check result.
    You can use the variable to see if the search was successful. If the dependency check passes, the value will be an empty string. If the dependency check fails, the value will be the value defined in the dependencyFailedMessage property.
    
    See Also:
    
    setDependencyFailedMessage(String)
  - getDependencyFailedResultVariable
```
public java.lang.String getDependencyFailedResultVariable()
```
    The variable where to store the component dependency check result.
    You can use the variable to see if the search was successful. If the dependency check passes, the value will be an empty string. If the dependency check fails, the value will be the value defined in the dependencyFailedMessage property.
    
    See Also:
    
    getDependencyFailedMessage()

Class ComponentDependency

Constructor Summary

Method Summary

Methods inherited from class com.zerog.ia.auto.project.InstallableObject

Methods inherited from class com.zerog.ia.auto.project.ProjectObject

Methods inherited from class java.lang.Object

Constructor Detail

ComponentDependency

Method Detail

setMatchesKeyFile

getMatchesKeyFile

setKeyFile

getKeyFile

setMatchingKeyFileResultVariable

getMatchingKeyFileResultVariable

setCheckVersionAtLeast

getCheckVersionAtLeast

setCheckVersionAtMost

getCheckVersionAtMost

setVersionAtMost

getVersionAtMost

setVersionAtLeast

getVersionAtLeast

setParentComponent

getParentComponent

setDependencyFailedMessage

getDependencyFailedMessage

setDependencyFailedResultVariable

getDependencyFailedResultVariable