Package org.lfenergy.compas.sct.commons.scl.header

Class HeaderAdapter

java.lang.Object

org.lfenergy.compas.sct.commons.scl.SclElementAdapter<SclRootAdapter,THeader>

org.lfenergy.compas.sct.commons.scl.header.HeaderAdapter

public class HeaderAdapter
extends SclElementAdapter<SclRootAdapter,THeader>

A representation of the model object Header.

The following features are supported:

• add History
• update Version
• update Revision
• Add TPrivate under this object

See Also:

• SclRootAdapter
• THeader
• THitem
• Issue !88

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_TOOL_ID	The default value of the ToolID attribute.

Fields inherited from class org.lfenergy.compas.sct.commons.scl.SclElementAdapter

currentElem, parentAdapter

Constructor Summary

Constructors

Constructor	Description
HeaderAdapter(SclRootAdapter parentAdapter, THeader currentElem)	Constructor

Method Summary

Modifier and Type	Method	Description
HeaderAdapter	addHistoryItem(String who, String what, String why)
protected boolean	amChildElementRef()	Check if node is child of the reference node
protected String	elementXPath()	Returns XPath path to current element
String	getHeaderId()	Returns the value of the id attribute.
String	getHeaderRevision()	Returns the value of the Revision attribute.
String	getHeaderVersion()	Returns the value of the Version attribute.
List<THitem>	getHistoryItems()	Returns the value of the History containment reference list.
void	updateRevision(String hRevision)	Update the value of the Revision attribute
void	updateVersion(String hVersion)	Update the value of the Version attribute

Methods inherited from class org.lfenergy.compas.sct.commons.scl.SclElementAdapter

addPrivate, amRootElement, buildFatalReportItem, customInit, getXPath, setCurrentElem

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_TOOL_ID

public static final String DEFAULT_TOOL_ID

The default value of the ToolID attribute.

See Also:

• THeader.getToolID()
• Constant Field Values

Constructor Details

HeaderAdapter

public HeaderAdapter(SclRootAdapter parentAdapter,
 THeader currentElem)

Constructor

Parameters:

parentAdapter - Parent container reference

currentElem - Current reference

Method Details

amChildElementRef

protected boolean amChildElementRef()

Description copied from class: SclElementAdapter

Check if node is child of the reference node

Specified by:

amChildElementRef in class SclElementAdapter<SclRootAdapter,THeader>

Returns:

link parent child existence

elementXPath

protected String elementXPath()

Description copied from class: SclElementAdapter

Returns XPath path to current element

Specified by:

elementXPath in class SclElementAdapter<SclRootAdapter,THeader>

Returns:

message as undefined

addHistoryItem

public HeaderAdapter addHistoryItem(String who,
 String what,
 String why)

Parameters:

who - input

what - input

why - input

Returns:

HeaderAdapter

See Also:

• Issue !6
• Issue !71

getHeaderId

public String getHeaderId()

Returns the value of the id attribute.

Returns:

the value of the id attribute.

getHeaderRevision

public String getHeaderRevision()

Returns the value of the Revision attribute.

Returns:

the value of the Revision attribute.

getHeaderVersion

public String getHeaderVersion()

Returns the value of the Version attribute.

Returns:

the value of the Version attribute.

getHistoryItems

public List<THitem> getHistoryItems()

Returns the value of the History containment reference list. The list contents are of type THitem.

Returns:

the value of the History containment reference list.

updateVersion

public void updateVersion(String hVersion)

Update the value of the Version attribute

Parameters:

hVersion - input

updateRevision

public void updateRevision(String hRevision)

Update the value of the Revision attribute

Parameters:

hRevision - input