com.almworks.structure.gantt.api.gantt

Interface GanttChart

@PublicApi
public interface GanttChart

This interface represents a Gantt chart.

Since:

4.1

Method Summary

Modifier and Type	Method and Description
long	getConfigId() Gets the configuration ID associated with this Gantt chart.
String	getConfigName() Gets the name of the configuration associated with this Gantt chart.
java.time.ZonedDateTime	getCreatedAt()
String	getCreator() Retrieves the key of the user who created the Gantt chart.
long	getId()
String	getName() Gets the name of the Gantt chart.
java.time.LocalDate	getStartDate() Gets the start date of the Gantt chart.
long	getStructureId() Gets the structure ID which this Gantt chart belongs to.

Method Detail

getId

long getId()

Returns:

the unique identifier of this Gantt chart

getConfigId

long getConfigId()

Gets the configuration ID associated with this Gantt chart.

Returns:

the configuration ID

getStructureId

long getStructureId()

Gets the structure ID which this Gantt chart belongs to.

Returns:

the structure ID

getName

@Nullable
String getName()

Gets the name of the Gantt chart. The name is null by default.

Returns:

the name of this Gantt chart or null if it is not set

getConfigName

@NotNull
String getConfigName()

Gets the name of the configuration associated with this Gantt chart.

Returns:

the configuration name, not null

getStartDate

@NotNull
java.time.LocalDate getStartDate()

Gets the start date of the Gantt chart.

Returns:

the start date of this Gantt chart, not null

getCreatedAt

@NotNull
java.time.ZonedDateTime getCreatedAt()

Returns:

the ZonedDateTime when the Gantt chart was created.

Since:

4.2

getCreator

@NotNull
String getCreator()

Retrieves the key of the user who created the Gantt chart.

Returns:

the key of the user who created this Gantt chart.

Since:

4.2