Package com.xebialabs.xlrelease.domain
Class Phase
- java.lang.Object
-
- com.xebialabs.deployit.plugin.api.udm.base.BaseConfigurationItem
-
- com.xebialabs.xlrelease.domain.PlanItem
-
- com.xebialabs.xlrelease.domain.Phase
-
- All Implemented Interfaces:
ConfigurationItem,TaskContainer,VisitableItem,java.io.Serializable,java.lang.Comparable<BaseConfigurationItem>
@Metadata(description="A phase in a release that contains tasks.", versioned=false) public class Phase extends PlanItem implements TaskContainer
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.Stringcolorprotected java.lang.StringoriginIdprotected PhaseStatusstatus-
Fields inherited from class com.xebialabs.xlrelease.domain.PlanItem
BY_TITLE, description, dueDate, endDate, flagComment, flagStatus, overdueNotified, owner, plannedDuration, scheduledStartDate, startDate, title
-
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 Phase()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Changesabort()voidaccept(ReleaseVisitor visitor)voidaddTask(Task task, int position)Changesclose()voiddeleteTask(Task task)Changesfail()Changesfailing()ChangesfailTask(java.lang.String targetTaskId, java.lang.String failReason, User user)ChangesfailTask(java.lang.String targetTaskId, java.lang.String failReason, User user, boolean fromAbort)java.util.List<GateTask>getAllGates()java.util.List<Task>getAllTasks()java.lang.StringgetAncestorId()java.util.List<PlanItem>getChildren()java.lang.StringgetColor()TaskgetCurrentTask()java.lang.StringgetDisplayPath()java.lang.StringgetOriginId()ReleasegetRelease()java.lang.StringgetReleaseOwner()java.lang.IntegergetReleaseUid()PhaseStatusgetStatus()TaskgetTask(java.lang.Integer index)TaskgetTask(java.lang.String taskId)java.util.List<Task>getTasks()java.util.List<UsagePoint>getVariableUsages()booleanhasBeenStarted()booleanhasCurrentTask()booleanisAborted()booleanisActive()booleanisDefunct()booleanisDone()booleanisFailed()booleanisFailing()booleanisLatestCopy()booleanisOriginal()booleanisPhaseCopied()Checks within the phase release if there is another phase that has its originId filled and referring to this phase.booleanisPlanned()booleanisUpdatable()ChangesmarkTaskAsDone(java.lang.String taskId, TaskStatus status)ChangesresetToPlanned()ChangesretryTask(java.lang.String taskId)voidsetColor(java.lang.String color)voidsetOriginId(java.lang.String originId)voidsetRelease(Release release)voidsetReleaseUid(java.lang.Integer releaseUid)voidsetStatus(PhaseStatus status)voidsetTasks(java.util.List<Task> tasks)Changesstart()ChangesstartPendingTask(java.lang.String targetTaskId)ChangesstartWithInput(java.lang.String targetTaskId)ChangestaskPreconditionValidated(java.lang.String targetTaskId)-
Methods inherited from class com.xebialabs.xlrelease.domain.PlanItem
calculateDueDate, checkDatesValidity, getActualDuration, getComputedPlannedDuration, getDescription, getDueDate, getEndDate, getEndOrDueDate, getFlagComment, getFlagStatus, getOrCalculateDueDate, getOwner, getPlannedDuration, getScheduledStartDate, getStartDate, getStartOrScheduledDate, getTitle, hasDueDate, hasEndDate, hasEndOrDueDate, hasOwner, hasOwner, hasPlannedDuration, hasScheduledStartDate, hasStartDate, hasStartOrScheduledDate, hasTitle, hasTitle, hasValidStartDates, isFlagged, isOverdue, isOverdueNotified, isTitleContaining, moveChildren, setDates, setDescription, setDueDate, setEndDate, setFlagComment, setFlagStatus, setOverdueNotified, setOwner, setPlannedDuration, setScheduledStartDate, setStartAndEndDatesIfEmpty, setStartDate, setTitle, shouldNotifyOverdue, updateDates, updateDuration
-
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
-
Methods inherited from interface com.xebialabs.xlrelease.domain.TaskContainer
getTitle, isLocked, replaceTask, replaceTask
-
-
-
-
Field Detail
-
status
@Property(description="The state the phase is in.") protected PhaseStatus status
-
color
@Property(description="The color of the phase top bar in the UI. Format: #(hex value); for example \'#3D6C9E\'") protected java.lang.String color
-
originId
@Property(required=false, description="If given, then this phase has been copied as a part of restart phase operation based on this id") protected java.lang.String originId
-
-
Method Detail
-
getTasks
public java.util.List<Task> getTasks()
- Specified by:
getTasksin interfaceTaskContainer
-
setTasks
public void setTasks(java.util.List<Task> tasks)
- Specified by:
setTasksin interfaceTaskContainer
-
getCurrentTask
public Task getCurrentTask()
-
hasCurrentTask
public boolean hasCurrentTask()
-
getRelease
public Release getRelease()
- Specified by:
getReleasein classPlanItem
-
getReleaseUid
public java.lang.Integer getReleaseUid()
- Specified by:
getReleaseUidin classPlanItem
-
setReleaseUid
public void setReleaseUid(java.lang.Integer releaseUid)
- Specified by:
setReleaseUidin classPlanItem
-
getDisplayPath
public java.lang.String getDisplayPath()
- Specified by:
getDisplayPathin classPlanItem
-
setRelease
public void setRelease(Release release)
-
getStatus
public PhaseStatus getStatus()
-
setStatus
public void setStatus(PhaseStatus status)
-
getColor
public java.lang.String getColor()
-
setColor
public void setColor(java.lang.String color)
-
getOriginId
public java.lang.String getOriginId()
-
setOriginId
public void setOriginId(java.lang.String originId)
-
start
public Changes start()
-
startPendingTask
public Changes startPendingTask(java.lang.String targetTaskId)
-
startWithInput
public Changes startWithInput(java.lang.String targetTaskId)
-
taskPreconditionValidated
public Changes taskPreconditionValidated(java.lang.String targetTaskId)
-
markTaskAsDone
public Changes markTaskAsDone(java.lang.String taskId, TaskStatus status)
-
failTask
public Changes failTask(java.lang.String targetTaskId, java.lang.String failReason, User user)
-
failTask
public Changes failTask(java.lang.String targetTaskId, java.lang.String failReason, User user, boolean fromAbort)
-
retryTask
public Changes retryTask(java.lang.String taskId)
-
abort
public Changes abort()
-
fail
public Changes fail()
-
failing
public Changes failing()
-
getTask
public Task getTask(java.lang.Integer index)
-
resetToPlanned
public Changes resetToPlanned()
-
hasBeenStarted
public boolean hasBeenStarted()
- Specified by:
hasBeenStartedin classPlanItem
-
isDefunct
public boolean isDefunct()
-
isUpdatable
public boolean isUpdatable()
- Specified by:
isUpdatablein classPlanItem
-
isPlanned
public boolean isPlanned()
-
isFailed
public boolean isFailed()
-
isFailing
public boolean isFailing()
-
getReleaseOwner
public java.lang.String getReleaseOwner()
-
getAllGates
public java.util.List<GateTask> getAllGates()
-
getAllTasks
public java.util.List<Task> getAllTasks()
-
getChildren
public java.util.List<PlanItem> getChildren()
- Specified by:
getChildrenin classPlanItem
-
accept
public void accept(ReleaseVisitor visitor)
- Specified by:
acceptin interfaceVisitableItem
-
getVariableUsages
public java.util.List<UsagePoint> getVariableUsages()
- Specified by:
getVariableUsagesin classPlanItem
-
close
public Changes close()
-
getTask
public Task getTask(java.lang.String taskId)
-
addTask
public void addTask(Task task, int position)
- Specified by:
addTaskin interfaceTaskContainer
-
deleteTask
public void deleteTask(Task task)
-
isOriginal
public boolean isOriginal()
-
isPhaseCopied
public boolean isPhaseCopied()
Checks within the phase release if there is another phase that has its originId filled and referring to this phase.- Returns:
-
getAncestorId
public java.lang.String getAncestorId()
-
isLatestCopy
public boolean isLatestCopy()
-
-