ptdb.common.dto

Class XMLDBModelWithReferenceChanges

java.lang.Object

ptdb.common.dto.XMLDBModelWithReferenceChanges

public class XMLDBModelWithReferenceChanges
extends java.lang.Object

Encapsulate the information needed by the business layer to perform a save operation with parent references being affected by the change done on the model to be saved.

The Data Transfer Object pattern is used here.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Yousef Alsaeed

Pt.AcceptedRating:

Red (yalsaeed)

Pt.ProposedRating:

Red (yalsaeed)

Field Summary

Fields

Modifier and Type	Field and Description
(package private) XMLDBModel	_modelToBeSaved The model to be saved in the database.
(package private) java.util.ArrayList<java.lang.String>	_parentsList The list of parents being affected by the changes made on the model.
(package private) java.lang.String	_versionName The new model name that will be stored in the database.

Constructor Summary

Constructors

Constructor and Description
XMLDBModelWithReferenceChanges(XMLDBModel modelToBeSaved, java.util.ArrayList<java.lang.String> parentsList, java.lang.String versionName) Construct a new instance of this class and set the member variables.

Method Summary

Modifier and Type	Method and Description
XMLDBModel	getModelToBeSaved() Return the model to be saved in the database.
java.util.ArrayList<java.lang.String>	getParentsList() Return The list of parents being affected by the changes made on the model.
java.lang.String	getVersionName() Return The new model name that will be stored in the database.
void	setModelToBeSaved(XMLDBModel modelToBeSaved) Set The model to be saved in the database.
void	setParentsList(java.util.ArrayList<java.lang.String> parentsList) Set The list of parents being affected by the changes made on the model.
void	setVersionName(java.lang.String versionName) Set The new model name that will be stored in the database.

Methods inherited from class java.lang.Object

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

Field Detail

_modelToBeSaved

XMLDBModel _modelToBeSaved

The model to be saved in the database.

_parentsList

java.util.ArrayList<java.lang.String> _parentsList

The list of parents being affected by the changes made on the model.

_versionName

java.lang.String _versionName

The new model name that will be stored in the database.

Constructor Detail

XMLDBModelWithReferenceChanges

public XMLDBModelWithReferenceChanges(XMLDBModel modelToBeSaved,
                                      java.util.ArrayList<java.lang.String> parentsList,
                                      java.lang.String versionName)

Construct a new instance of this class and set the member variables.

Parameters:

modelToBeSaved - The model to be saved in the database with no changes.

parentsList - List of parents that should have the new model name as the reference inside them with the old content.

versionName - A new name of the model which will be converted into a model that contains the content of the modelToBeSaved before saving it.

Method Detail

getModelToBeSaved

public XMLDBModel getModelToBeSaved()

Return the model to be saved in the database.

Returns:

The model to be saved in the database.

See Also:

setModelToBeSaved(ptdb.common.dto.XMLDBModel)

getParentsList

public java.util.ArrayList<java.lang.String> getParentsList()

Return The list of parents being affected by the changes made on the model.

Returns:

The list of parents being affected by the changes made on the model.

See Also:

setParentsList(java.util.ArrayList<java.lang.String>)

getVersionName

public java.lang.String getVersionName()

Return The new model name that will be stored in the database.

Returns:

The new model name that will be stored in the database.

See Also:

setVersionName(java.lang.String)

setModelToBeSaved

public void setModelToBeSaved(XMLDBModel modelToBeSaved)

Set The model to be saved in the database.

Parameters:

modelToBeSaved - The model to be saved in the database.

See Also:

getModelToBeSaved()

setParentsList

public void setParentsList(java.util.ArrayList<java.lang.String> parentsList)

Set The list of parents being affected by the changes made on the model.

Parameters:

parentsList - The list of parents being affected by the changes made on the model.

See Also:

getParentsList()

setVersionName

public void setVersionName(java.lang.String versionName)

Set The new model name that will be stored in the database.

Parameters:

versionName - The new model name that will be stored in the database.

See Also:

getVersionName()