Package com.xebialabs.xlrelease.domain
Class Dependency
- java.lang.Object
-
- com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem
-
- com.xebialabs.xlrelease.domain.Dependency
-
- All Implemented Interfaces:
ConfigurationItem,CiWithInternalMetadata,java.io.Serializable,java.lang.Comparable<BaseConfigurationItem>
@Metadata(description="A dependency to another release, phase or task in a Gate task.", versioned=false) public class Dependency extends BaseConfigurationItem implements CiWithInternalMetadata
Dependency is a link from a gate task to a plan item (release, phase or task) on which the gate depends.There are several possible states of a dependency:
-
Variable dependency. In this case the
targetIdcontains a variable expression like ${varPhaseId}, andtargetis null. -
Dependency with string target. In this case the
targetIdcontains a plan item ID, andtargetis null. -
Normal dependency. In this case the
targetfield points to the plan item on which thegateTaskdepends. -
Archived dependency. A dependency becomes "archived" when the target plan item was deleted, for example when
archiving old completed releases. In this case the
targetisnull, and the information about archived plan item is stored in fieldsarchivedTargetId,archivedTargetTitleandarchivedAsResolved. The latter shows if the plan item wasCOMPLETEDorABORTED.
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringPROPERTY_TARGETstatic java.lang.StringTYPE_DEPENDENCY-
Fields inherited from class com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem
id, syntheticProperties, type
-
Fields inherited from interface com.xebialabs.deployit.plugin.api.udm.ConfigurationItem
SYNTHETIC_PROPERTIES_FIELD, TYPE_FIELD
-
-
Constructor Summary
Constructors Constructor Description Dependency()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidarchive()static java.lang.StringcreateArchivedTargetTitle(PlanItem planItem)java.util.Map<java.lang.String,InternalMetadata>get$metadata()java.lang.StringgetArchivedTargetId()java.lang.StringgetArchivedTargetTitle()GateTaskgetGateTask()<T extends PlanItem>
TgetTarget()java.lang.StringgetTargetDisplayPath()java.lang.StringgetTargetId()java.lang.StringgetTargetTitle()booleanhasResolvedTarget()booleanhasValidArchiveTargetId()booleanhasVariableTarget()booleanisAborted()booleanisArchived()booleanisArchivedAsResolved()booleanisDone()voidsetGateTask(GateTask gateTask)voidsetTarget(PlanItem target)voidsetTargetId(java.lang.String targetId)-
Methods inherited from class com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem
compareTo, equals, get$ciAttributes, get$directoryReference, get$externalProperties, get$internalId, get$referenceId, get$securedCi, get$securedDirectoryReference, get$token, get$validationMessages, getId, getName, getProperty, getPropertyDescriptor, getType, hashCode, hasProperty, set$ciAttributes, set$directoryReference, set$externalProperties, set$internalId, set$referenceId, set$securedCi, set$securedDirectoryReference, set$token, set$validationMessages, setId, setProperty, setType, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.xebialabs.deployit.plugin.api.udm.ConfigurationItem
get$directoryReference, get$internalId, get$referenceId, get$securedCi, get$securedDirectoryReference, get$validationMessages, getId, getName, getProperty, getType, hasProperty, setId, setProperty
-
-
-
-
Field Detail
-
TYPE_DEPENDENCY
public static final java.lang.String TYPE_DEPENDENCY
-
PROPERTY_TARGET
public static final java.lang.String PROPERTY_TARGET
- See Also:
- Constant Field Values
-
-
Method Detail
-
getGateTask
public GateTask getGateTask()
-
setGateTask
public void setGateTask(GateTask gateTask)
-
getTarget
public <T extends PlanItem> T getTarget()
-
setTarget
public void setTarget(PlanItem target)
-
getTargetId
public java.lang.String getTargetId()
-
setTargetId
public void setTargetId(java.lang.String targetId)
-
getArchivedTargetId
public java.lang.String getArchivedTargetId()
-
getArchivedTargetTitle
public java.lang.String getArchivedTargetTitle()
-
isArchived
public boolean isArchived()
-
isDone
public boolean isDone()
-
isAborted
public boolean isAborted()
-
getTargetDisplayPath
public java.lang.String getTargetDisplayPath()
-
getTargetTitle
public java.lang.String getTargetTitle()
-
archive
public void archive()
-
isArchivedAsResolved
public boolean isArchivedAsResolved()
-
createArchivedTargetTitle
public static java.lang.String createArchivedTargetTitle(PlanItem planItem)
-
hasResolvedTarget
public boolean hasResolvedTarget()
-
hasVariableTarget
public boolean hasVariableTarget()
-
hasValidArchiveTargetId
public boolean hasValidArchiveTargetId()
-
get$metadata
public java.util.Map<java.lang.String,InternalMetadata> get$metadata()
- Specified by:
get$metadatain interfaceCiWithInternalMetadata
-
-