com.almworks.structure.gantt.api.baseline

Interface BaselineManager

@PublicApi
public interface BaselineManager

This manager allows users to retrieve, create and delete baselines.

Since:

4.1

Method Summary

Modifier and Type	Method and Description
Baseline	createBaseline(long ganttId, String name, BaselineType type, Map<String,Object> params) Create new baseline for specified gantt
Baseline	getBaseline(long baselineId) Retrieves a specific baseline by its ID.
List<Baseline>	getBaselines(long ganttId) Retrieves all baselines associated with a specified Gantt chart.
BaselineUpdateBuilder	getUpdateBuilder(long baselineId) Creates a builder for updating a specified baseline.
void	removeBaseline(long baselineId) Deletes the specified baseline.

Method Detail

getBaselines

@NotNull
List<Baseline> getBaselines(long ganttId)
                              throws GanttBaselineException

Retrieves all baselines associated with a specified Gantt chart.

Parameters:

ganttId - the unique identifier of gantt for which it is required to get the list of baselines

Returns:

the list of baselines for specified gantt

Throws:

GanttBaselineException - exception if an error occurs

getBaseline

@Nullable
Baseline getBaseline(long baselineId)
                        throws GanttBaselineException

Retrieves a specific baseline by its ID.

Parameters:

baselineId - the ID of the baseline to retrieve.

Returns:

the baseline associated with the given ID, or null if no such baseline exists.

Throws:

GanttBaselineException - If an error occurs during retrieval.

createBaseline

@NotNull
Baseline createBaseline(long ganttId,
                                 @NotNull
                                 String name,
                                 @NotNull
                                 BaselineType type,
                                 @NotNull
                                 Map<String,Object> params)
                          throws GanttBaselineException

Create new baseline for specified gantt

Parameters:

ganttId - the unique identifier of the Gantt chart for which the baseline is being created

name - the name assigned to the new baseline

type - the type of the baseline

params - a map of parameters for the new baseline. See available baseline params here BaselineParams

Returns:

created baseline object

Throws:

GanttBaselineException - If an error occurs during the creation process. For example, if passed parameter is not applicable for the specified type.

See Also:

BaselineType, Baseline

getUpdateBuilder

@NotNull
BaselineUpdateBuilder getUpdateBuilder(long baselineId)

Creates a builder for updating a specified baseline.

Parameters:

baselineId - the identifier of the baseline to be updated.

Returns:

the BaselineUpdateBuilder which can be used to update specified baseline

See Also:

BaselineUpdateBuilder

removeBaseline

void removeBaseline(long baselineId)
             throws GanttBaselineException

Deletes the specified baseline.

Parameters:

baselineId - the unique identifier of the baseline to be deleted.

Throws:

GanttBaselineException - exception if an error occurs