com.vordel.env

Class EnvironmentalizedEntity

java.lang.Object

com.vordel.env.EnvironmentalizedEntity

All Implemented Interfaces:

java.lang.Comparable<EnvironmentalizedEntity>

public class EnvironmentalizedEntity
extends java.lang.Object
implements java.lang.Comparable<EnvironmentalizedEntity>

This class represents an environmentalized entity in the EnvSettingsStore.xml of a Deployment Archive. The EnvironmentalizedEntities class contains a collection of EnvironmentalizedEntity objects.

Constructor Summary

Constructors

Constructor and Description
EnvironmentalizedEntity() Default constructor.
EnvironmentalizedEntity(java.lang.String entityPk, java.lang.String type, java.lang.String keyDescription) Constructor.
EnvironmentalizedEntity(java.lang.String entityPk, java.lang.String type, java.lang.String keyDescription, java.util.Collection<EnvironmentalizedEntityField> environmentalizedFields) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addEnvironmentalizedField(EnvironmentalizedEntityField field) Add an environmentalized field.
int	compareTo(EnvironmentalizedEntity ee)
java.lang.String	getEntityPk() Get the ESPK of the entity that is being environmentalized.
java.util.Collection<EnvironmentalizedEntityField>	getEnvironmentalizedFields() Get the collection of fields that have been environmentalized for the entity.
java.lang.String	getKeyDescription() Get key description of the entity that is being environmentalized.
java.lang.String	getType() Get the entity type of the entity that is being environmentalized.
void	setEntityPk(java.lang.String entityPk) Set the ESPK of the entity that is being environmentalized.
void	setEnvironmentalizedFields(java.util.Collection<EnvironmentalizedEntityField> environmentalizedFields) Set the collection of fields that have been environmentalized for the entity.
void	setKeyDescription(java.lang.String keyDescription) Set key description of the entity that is being environmentalized.
void	setType(java.lang.String type) Set the entity type of the entity that is being environmentalized.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentalizedEntity

public EnvironmentalizedEntity()

Default constructor.

EnvironmentalizedEntity

public EnvironmentalizedEntity(java.lang.String entityPk,
                       java.lang.String type,
                       java.lang.String keyDescription,
                       java.util.Collection<EnvironmentalizedEntityField> environmentalizedFields)

Constructor.

Parameters:

entityPk - The ESPK of the entity that is being environmentalized, e.g. ESPK to an instance of a DbConnection entity.

type - The entity type of the entity that is being environmentalized, e.g. DbConnection.

keyDescription - The key description of the entity that is being environmentalized.

environmentalizedFields - Collection of fields that have been environmentalized for the entity, e.g. url, username, password.

EnvironmentalizedEntity

public EnvironmentalizedEntity(java.lang.String entityPk,
                       java.lang.String type,
                       java.lang.String keyDescription)

Constructor.

Parameters:

entityPk - The ESPK of the entity that is being environmentalized.

type - The entity type of the entity that is being environmentalized.

keyDescription - The key description of the entity that is being environmentalized.

Method Detail

getEntityPk

public java.lang.String getEntityPk()

Get the ESPK of the entity that is being environmentalized.

Returns:

ESPK

setEntityPk

public void setEntityPk(java.lang.String entityPk)

Set the ESPK of the entity that is being environmentalized.

Parameters:

entityPk - The ESPK

getType

public java.lang.String getType()

Get the entity type of the entity that is being environmentalized.

Returns:

Entity type.

setType

public void setType(java.lang.String type)

Set the entity type of the entity that is being environmentalized.

Parameters:

type - Entity type

getKeyDescription

public java.lang.String getKeyDescription()

Get key description of the entity that is being environmentalized.

Returns:

Key description

setKeyDescription

public void setKeyDescription(java.lang.String keyDescription)

Set key description of the entity that is being environmentalized.

Parameters:

keyDescription - Key description

setEnvironmentalizedFields

public void setEnvironmentalizedFields(java.util.Collection<EnvironmentalizedEntityField> environmentalizedFields)

Set the collection of fields that have been environmentalized for the entity. For example for a DbConnection entity, the user may environmentalize the url, username and password fields.

Parameters:

environmentalizedFields - The environmentalized fields

getEnvironmentalizedFields

public java.util.Collection<EnvironmentalizedEntityField> getEnvironmentalizedFields()

Get the collection of fields that have been environmentalized for the entity.

Returns:

The environmentalized fields

addEnvironmentalizedField

public void addEnvironmentalizedField(EnvironmentalizedEntityField field)

Add an environmentalized field.

Parameters:

field - An environmentalized field

compareTo

public int compareTo(EnvironmentalizedEntity ee)

Specified by:

compareTo in interface java.lang.Comparable<EnvironmentalizedEntity>