Skip navigation links

ilog.rules.teamserver.brm
Interface IlrBaseline

All Superinterfaces:

Cloneable, IlrBasicModelElement, ilog.rules.teamserver.model.IlrCompositeObject, ilog.rules.commonbrm.model.IlrElement, IlrElementDetails, IlrElementHandle, IlrElementSummary, IlrModelElement, Serializable

All Known Subinterfaces:

IlrActivity, IlrBranch, IlrChangeAct, IlrManagedBranch, IlrReferencingBsln, IlrRelease, IlrSnapshot, IlrTimestampBsln, IlrValidationAct

public interface IlrBaseline
extends IlrModelElement

A representation of the model object 'Baseline'.

The following features are supported:

• Parent
• Baseline Kind
• Readable Version
• Frozen
• Documentation
• Dep Name
• Event Id String

See Also:

IlrBrmPackage.getBaseline()

Method Summary

IlrBaselineKind	getBaselineKind() Returns the value of the 'Baseline Kind' attribute.
String	getDepName() Returns the value of the 'Dep Name' attribute.
String	getDocumentation() Returns the value of the 'Documentation' attribute.
String	getEventIdString() Returns the value of the 'Event Id String' attribute.
IlrBaseline	getParent() Returns the value of the 'Parent' reference.
IlrRuleProject	getProject() Gets this project's baseline.
IlrElementHandle	getProjectHandle() Gets the handle on this project's baseline.
IlrProjectInfo	getProjectInfo() Gets the project info associated with this baseline.
int	getReadableVersion() Returns the value of the 'Readable Version' attribute.
boolean	isFrozen() Returns the value of the 'Frozen' attribute.
boolean	isSystem() Indicates whether this baseline is a system baseline or not.

Methods inherited from interface ilog.rules.teamserver.brm.IlrModelElement

getName, getUuid

Methods inherited from interface ilog.rules.teamserver.brm.IlrBasicModelElement

getCreatedBy, getCreatedOn, getLastChangedBy, getLastChangedOn

Methods inherited from interface ilog.rules.teamserver.model.IlrElementDetails

cloneElement, getContainer, getRawValue, setRawValue, setRawValueNoCheck

Methods inherited from interface ilog.rules.teamserver.model.IlrElementHandle

eClass, equals, equals, getModelInfo, getSession, getType, getValue, hashCode, isNew, toIdString

Methods inherited from interface ilog.rules.commonbrm.model.IlrElement

getPropertyValue, getPropertyValue, isInstanceOf

Method Detail

getParent

IlrBaseline getParent()
                      throws IlrObjectNotFoundException

Returns the value of the 'Parent' reference.

If the meaning of the 'Parent' reference isn't clear, there really should be more of a description here...

Throws:

IlrObjectNotFoundException

Returns:

the value of the 'Parent' reference.

See Also:

IlrBrmPackage.getBaseline_Parent()

getBaselineKind

IlrBaselineKind getBaselineKind()

Returns the value of the 'Baseline Kind' attribute.

The default value is "Standard". The literals are from the enumeration IlrBaselineKind.

If the meaning of the 'Baseline Kind' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Baseline Kind' attribute.

See Also:

IlrBaselineKind, IlrBrmPackage.getBaseline_BaselineKind()

getReadableVersion

int getReadableVersion()

Returns the value of the 'Readable Version' attribute.

If the meaning of the 'Readable Version' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Readable Version' attribute.

See Also:

IlrBrmPackage.getBaseline_ReadableVersion()

isFrozen

boolean isFrozen()

Returns the value of the 'Frozen' attribute.

The default value is "true".

If the meaning of the 'Frozen' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Frozen' attribute.

See Also:

IlrBrmPackage.getBaseline_Frozen()

getDocumentation

String getDocumentation()

Returns the value of the 'Documentation' attribute.

If the meaning of the 'Documentation' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Documentation' attribute.

See Also:

IlrBrmPackage.getBaseline_Documentation()

getDepName

String getDepName()

Returns the value of the 'Dep Name' attribute.

If the meaning of the 'Dep Name' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Dep Name' attribute.

See Also:

IlrBrmPackage.getBaseline_DepName()

getEventIdString

String getEventIdString()

Returns the value of the 'Event Id String' attribute.

If the meaning of the 'Event Id String' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Event Id String' attribute.

See Also:

IlrBrmPackage.getBaseline_EventIdString()

getProjectHandle

IlrElementHandle getProjectHandle()

Gets the handle on this project's baseline.

Returns:

A project handle.

getProject

IlrRuleProject getProject()
                          throws IlrObjectNotFoundException

Gets this project's baseline.

Throws:

IlrObjectNotFoundException - If the project cannot be found in the database

Returns:

A project.

getProjectInfo

IlrProjectInfo getProjectInfo()
                              throws IlrObjectNotFoundException

Gets the project info associated with this baseline.

Throws:

IlrObjectNotFoundException - If the project info cannot be found in the database.

Returns:

A project info object.

isSystem

boolean isSystem()

Indicates whether this baseline is a system baseline or not.

A system baseline means either the current baseline, that is, the current state of the project, or the recycle bin.

Returns:

True if the baseline is a system baseline.