Package com.polarion.alm.shared.api.model.plan

Interface Plan

All Superinterfaces:

CanRender<Renderer<? extends Renderer<?>>>, HasFields, HasReference<ModelEntityReference>, ModelEntity, ModelEntityBase<Plan,PlanReference>, ModelObject, ModelObjectBase<Plan,PlanReference>

All Known Subinterfaces:

UpdatablePlan

public interface Plan
extends ModelObjectBase<Plan,PlanReference>

Since:

3.9.0

Method Summary

Modifier and Type	Method	Description
IterableWithSize<Plan>	children()	Returns children plans sorted the same way as in the UI.
String	decorationColor()	Returns the decoration color for this plan either directly from color field, or from color field of the template of this plan.
PlanFields	fields()
com.polarion.alm.tracker.model.IPlan	getOldApi()
UpdatablePlan	getUpdatable(WriteTransaction transaction)
PlanWorkItems	items()	The shortcut for iterating over fields().PlanFields.records() and other helper methods related to Work Items contained in the Plan. The iterator never returns null value or the same value more than once.
String	label()	Returns label for the plan which is name or id.
PlanRenderer	render()
PlanStatistics	statistics()
PlanUtils	utils()

Methods inherited from interface com.polarion.alm.shared.api.model.ModelEntity

equals, hashCode, isUnresolvable, transaction

Methods inherited from interface com.polarion.alm.shared.api.model.ModelObject

can, copyFieldsTo, forget, resolve

Methods inherited from interface com.polarion.alm.shared.api.model.ModelObjectBase

getReference, getReferenceToCurrent, history

Method Details

render

@NotNull
PlanRenderer render()

Specified by:

render in interface CanRender<Renderer<? extends Renderer<?>>>

Specified by:

render in interface ModelEntity

label

@NotNull
String label()

Returns label for the plan which is name or id.

Specified by:

label in interface ModelObject

decorationColor

@NotNull
String decorationColor()

Returns the decoration color for this plan either directly from color field, or from color field of the template of this plan.

fields

@NotNull
PlanFields fields()

Specified by:

fields in interface HasFields

Specified by:

fields in interface ModelObject

items

@NotNull
PlanWorkItems items()

The shortcut for iterating over fields().PlanFields.records() and other helper methods related to Work Items contained in the Plan.

The iterator never returns null value or the same value more than once.

getUpdatable

@NotNull
UpdatablePlan getUpdatable(@NotNull
 WriteTransaction transaction)

Specified by:

getUpdatable in interface ModelObject

Specified by:

getUpdatable in interface ModelObjectBase<Plan,PlanReference>

getOldApi

@NotNull
@GwtIncompatible
com.polarion.alm.tracker.model.IPlan getOldApi()

Specified by:

getOldApi in interface ModelObject

statistics

@NotNull
PlanStatistics statistics()

children

@NotNull
IterableWithSize<Plan> children()

Returns children plans sorted the same way as in the UI.

utils

@NotNull
PlanUtils utils()