com.technia.tvc.xbom.xbl2

Class Baseline

java.lang.Object

com.technia.tvc.xbom.xbl2.Baseline

Direct Known Subclasses:

BaselineVersion

public class Baseline
extends java.lang.Object

This class represents an XBL Baseline object.

Since:

2009.3.0

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

Baseline(java.lang.String baselineOf, java.lang.String baselineObjectId, java.lang.String baselineType, java.lang.String baselineName, java.lang.String baselineRev, java.lang.String baselineState, boolean baselineEditable, boolean editAccess, java.lang.String description, java.lang.String purpose, java.util.Date originated, java.util.Date lastModified, java.util.List<BaselineVersion> versions, java.lang.String configId) Constructs a new Baseline instance.

Method Summary

Modifier and Type	Method and Description
static Baseline	create(BaselineConfig cfg) Creates a new baseline object in the database.
static BaselineVersion	createVersion(java.lang.String baselineObjectId, java.lang.String purpose) Creates a new baseline version
void	delete() Deletes the baseline among its versions.
static void	delete(java.lang.String oid)
static TableBean<? extends TableData>	getBaseline(java.lang.String baselineObjectId) Returns the baseline (the main section).
static TableBean<? extends TableData>	getBaseline(java.lang.String baselineObjectId, java.lang.String sectionId)
static void	getBaselineData(java.lang.String baselineObjectId, java.io.OutputStream out) Retrieves the XML data for a particular section within a baseline and writes the result into the specified output stream.
static Baseline	getBaselineInstance(java.lang.String objectId) Returns the baseline object represented by the provided object id
static java.lang.String[]	getBaselineObjectIds(java.lang.String objectId) Returns the id's of the baselines for a given object.
static java.lang.String[]	getBaselineObjectIds(java.lang.String objectId, java.lang.String typePattern, java.lang.String policy, java.lang.String vault) Returns the id's of the baselines for a given object and configuration.
java.lang.String	getBaselineOf()
static java.util.List<Baseline>	getBaselinesFor(java.lang.String objectId) Returns a list of Baseline instances available for the given object.
java.lang.String	getDescription()
boolean	getHasEditAccess()
boolean	getHasVersions()
java.util.Date	getLastModified()
java.lang.String	getName()
java.lang.String	getObjectId()
java.util.Date	getOriginated()
java.lang.String	getPurpose()
java.lang.String	getRevision()
static com.technia.tvc.xbom.xbl2.util.SectionInfo[]	getSections(java.lang.String baselineObjectId) Retrieves the available sections from the baseline
java.lang.String	getState()
static TableBean<? extends TableData>	getTableBean(java.lang.String forObject, BaselineConfig cfg)
static TableBean<? extends TableData>	getTableBean(java.lang.String forObject, BaselineConfig cfg, java.lang.String sectionId)
static TableBean<? extends TableData>	getTableBean(java.lang.String forObject, java.lang.String baselineObjectId)
java.lang.String	getType()
int	getVersionCount()
java.util.List<BaselineVersion>	getVersions()
static java.util.List<BaselineVersion>	getVersions(java.lang.String baselineObjectId) Returns the versions for this baseline.
static boolean	isBaseline(java.lang.String objectId) Returns true if the object is of type "TVC XBL Baseline".
boolean	isBaselineEditable()
static boolean	isBaselineEditable(java.lang.String baselineObjectId) Returns true if the baseline is editable and the user has modify access to the baseline object.
static boolean	isTypeBaseline(java.lang.String type) Returns true if the type-argument is "TVC XBL Baseline" (or a sub type).
boolean	isVersion()
void	renew() Renews the baseline by deleting old versions and regenerating the baseline based on the same settings.
static void	updateBaselineData(java.lang.String baselineObjectId, org.w3c.dom.Document dom)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Baseline

protected Baseline(java.lang.String baselineOf,
                   java.lang.String baselineObjectId,
                   java.lang.String baselineType,
                   java.lang.String baselineName,
                   java.lang.String baselineRev,
                   java.lang.String baselineState,
                   boolean baselineEditable,
                   boolean editAccess,
                   java.lang.String description,
                   java.lang.String purpose,
                   java.util.Date originated,
                   java.util.Date lastModified,
                   java.util.List<BaselineVersion> versions,
                   java.lang.String configId)

Constructs a new Baseline instance.

Parameters:

baselineOf -

baselineObjectId -

baselineType -

baselineName -

baselineRev -

baselineState -

baselineEditable -

editAccess -

description -

purpose -

originated -

lastModified -

versions -

Since:

2010.3.0

Method Detail

isVersion

public boolean isVersion()

Returns:

True if the baseline is a version of another baseline

Since:

2010.3.0

getBaselineOf

public java.lang.String getBaselineOf()

Returns:

The object id of the object, which this is a baseline for.

Since:

2010.3.0

getObjectId

public java.lang.String getObjectId()

Returns:

The object id of this object (the XBL Baseline object)

Since:

2010.3.0

getType

public java.lang.String getType()

Returns:

The type of this object (the XBL Baseline object)

Since:

2010.3.0

getName

public java.lang.String getName()

Returns:

The name of this object (the XBL Baseline object)

Since:

2010.3.0

getRevision

public java.lang.String getRevision()

Returns:

The revision of this object (the XBL Baseline object)

Since:

2010.3.0

getState

public java.lang.String getState()

Returns:

The state of this object (the XBL Baseline object)

Since:

2010.3.0

getVersions

public java.util.List<BaselineVersion> getVersions()

Returns:

The versions of this baseline (if any).

Since:

2010.3.0

getVersionCount

public int getVersionCount()

Returns:

The number of versions this baseline has

Since:

2010.3.0

getHasVersions

public boolean getHasVersions()

Returns:

True if this baseline has at least one version

Since:

2010.3.0

getOriginated

public java.util.Date getOriginated()

Returns:

The date when this baseline were created.

Since:

2010.3.0

getLastModified

public java.util.Date getLastModified()

Returns:

The date when this baseline was last modified.

Since:

2010.3.0

isBaselineEditable

public boolean isBaselineEditable()

Returns:

True if this baseline is marked as editable. Note: This method doesn't consider any access rules, it just returns if this baseline can be edited or not.

Since:

2010.3.0

See Also:

getHasEditAccess()

getHasEditAccess

public boolean getHasEditAccess()

Returns:

True if the current user has edit access to the XBL Baseline object according to its policy.

Since:

2010.3.0

getPurpose

public java.lang.String getPurpose()

Returns:

The purpose value of this object

Since:

2010.3.0

getDescription

public java.lang.String getDescription()

Returns:

The description of this object.

Since:

2010.3.0

delete

public void delete()
            throws TVCException

Deletes the baseline among its versions.

Throws:

TVCException - If unable to delete one of the object(s).

Since:

2010.3.0

getBaselinesFor

public static java.util.List<Baseline> getBaselinesFor(java.lang.String objectId)
                                                throws TVCException

Returns a list of Baseline instances available for the given object. If no baselines are related, the returned list is empty (never null).

Parameters:

objectId - The object id.

Returns:

A list of Baseline instances.

Throws:

TVCException - Upon DB errors.

Since:

2010.3.0

getBaselineInstance

public static Baseline getBaselineInstance(java.lang.String objectId)
                                    throws TVCException

Returns the baseline object represented by the provided object id

Parameters:

objectId - The ID of the XBL Baseline object

Returns:

A Baseline instance.

Throws:

TVCException - If we are unable to get the data from the database, OR, if the object id is not representing an XBL Baseline object.

Since:

2010.3.0

isBaseline

public static boolean isBaseline(java.lang.String objectId)
                          throws TVCException

Returns true if the object is of type "TVC XBL Baseline".

Parameters:

objectId - The id for the object to check.

Returns:

True if it is a baseline

Throws:

TVCException - If unable to get information about the type

Since:

2009.3.0

isTypeBaseline

public static boolean isTypeBaseline(java.lang.String type)
                              throws TVCException

Returns true if the type-argument is "TVC XBL Baseline" (or a sub type).

Parameters:

type - The type name

Returns:

True if it is a baseline

Throws:

TVCException - If unable to get information about the type

Since:

2009.3.0

isBaselineEditable

public static boolean isBaselineEditable(java.lang.String baselineObjectId)
                                  throws TVCException

Returns true if the baseline is editable and the user has modify access to the baseline object.

Parameters:

baselineObjectId - The object-id of the baseline object

Returns:

True if it is editable.

Throws:

TVCException - If unable to get the value from the database

Since:

2010.3.0

getVersions

public static java.util.List<BaselineVersion> getVersions(java.lang.String baselineObjectId)
                                                   throws TVCException

Returns the versions for this baseline.

Same as doing:

 List<BaselineVersion> versions = Baseline.getBaselineInstance(baselineObjectId).getVersions()
 

Parameters:

baselineObjectId - The main XBL

Returns:

A list of BaselineVersion instances (never null, but can be empty of course)

Throws:

TVCException

Since:

2010.3.0

createVersion

public static BaselineVersion createVersion(java.lang.String baselineObjectId,
                                            java.lang.String purpose)
                                     throws TVCException

Creates a new baseline version

Parameters:

baselineObjectId - The main XBL to create a version of

purpose - The purpose of the version.

Returns:

The new baseline as a BaselineVersion

Throws:

TVCException - If unable to perform the operation.

Since:

2010.3.0

getBaselineObjectIds

public static java.lang.String[] getBaselineObjectIds(java.lang.String objectId)

Returns the id's of the baselines for a given object.

Parameters:

objectId - The id of the object

Returns:

An array of object-id's, where each object is of type "XBL Baseline".

Since:

2009.3.0

getBaselineObjectIds

public static java.lang.String[] getBaselineObjectIds(java.lang.String objectId,
                                                      java.lang.String typePattern,
                                                      java.lang.String policy,
                                                      java.lang.String vault)

Returns the id's of the baselines for a given object and configuration.

Parameters:

objectId - The id of the object

configurationId - The id of the configuration

Returns:

An array of object-id's, where each object is of type "XBL Baseline".

Since:

2016.2.0

getTableBean

public static TableBean<? extends TableData> getTableBean(java.lang.String forObject,
                                                          java.lang.String baselineObjectId)
                                                   throws TVCException

Throws:

TVCException

getTableBean

public static TableBean<? extends TableData> getTableBean(java.lang.String forObject,
                                                          BaselineConfig cfg)
                                                   throws TVCException

Throws:

TVCException

getTableBean

public static TableBean<? extends TableData> getTableBean(java.lang.String forObject,
                                                          BaselineConfig cfg,
                                                          java.lang.String sectionId)
                                                   throws TVCException

Throws:

TVCException

getBaselineData

public static void getBaselineData(java.lang.String baselineObjectId,
                                   java.io.OutputStream out)
                            throws TVCException

Retrieves the XML data for a particular section within a baseline and writes the result into the specified output stream.

This method is mainly used for debugging and easier retrieval of the underlying XML data, as it is typically stored in a compressed (GZipp'ed) format.

Parameters:

baselineObjectId - The id of the baseline

out - The stream to which the data is written into.

Throws:

TVCException - Upon failure to get the data.

updateBaselineData

public static void updateBaselineData(java.lang.String baselineObjectId,
                                      org.w3c.dom.Document dom)
                               throws TVCException

Throws:

TVCException

getBaseline

public static TableBean<? extends TableData> getBaseline(java.lang.String baselineObjectId)
                                                  throws TVCException

Returns the baseline (the main section).

Parameters:

baselineObjectId -

Returns:

The baseline as a table bean instance.

Throws:

TVCException

See Also:

getBaseline(String, String)

getBaseline

public static TableBean<? extends TableData> getBaseline(java.lang.String baselineObjectId,
                                                         java.lang.String sectionId)
                                                  throws TVCException

Throws:

TVCException

create

public static Baseline create(BaselineConfig cfg)
                       throws TVCException

Creates a new baseline object in the database.

Parameters:

cfg - The configuration instance.

Returns:

The newly created Baseline instance.

Throws:

TVCException - Upon errors

getSections

public static com.technia.tvc.xbom.xbl2.util.SectionInfo[] getSections(java.lang.String baselineObjectId)
                                                                throws TVCException

Retrieves the available sections from the baseline

Parameters:

baselineObjectId - The ID of the baseline object

Returns:

An array of sections.

Throws:

TVCException

Since:

2010.3.0

delete

public static void delete(java.lang.String oid)
                   throws TVCException

Throws:

TVCException

renew

public void renew()
           throws TVCException

Renews the baseline by deleting old versions and regenerating the baseline based on the same settings.

Throws:

TVCException

Since:

2015.2.0