wt.eff
Class EffConfigurationItemIdentificationObject

java.lang.Object
  wt.fc.IdentificationObject
      wt.eff.EffConfigurationItemIdentificationObject

All Implemented Interfaces:

Externalizable, NetFactor, Serializable

public class EffConfigurationItemIdentificationObject

extends IdentificationObject

implements Externalizable

The identification object to be used by all implementations of configuration item.

Use the newEffConfigurationItemIdentificationObject static factory method(s), not the EffConfigurationItemIdentificationObject constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

EffConfigurationItem, Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private String	name
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.IdentificationObject

Constructor Summary

EffConfigurationItemIdentificationObject()

Method Summary

String	getConceptualClassname() Deprecated.
String	getIdentity() Constructs and returns a string representing the object's identity.
protected String	getKeyClassName() Returns wt.eff.EffContextKey.
String	getName() Gets the value of the attribute: name; The name of the configuration item is the key for all configuration item implementations.
protected void	initialize(EffConfigurationItem configItem) Supports initialization, following construction of an instance.
private void	nameValidate(String a_Name)
static EffConfigurationItemIdentificationObject	newEffConfigurationItemIdentificationObject(EffConfigurationItem configItem) The factory to be used by the configuration item's implementation of get/setIdentificationObject.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(EffConfigurationItemIdentificationObject thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setName(String a_Name) Sets the value of the attribute: name; The name of the configuration item is the key for all configuration item implementations.
protected void	setToObject(Identified obj) Updates the identity of the object passed as argument with the identity held in the object.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class wt.fc.IdentificationObject

changeIdentity, checkIdentity, createKey, getClassInfo, getSemanticKey, initialize, readVersion, setAdditionalKeyAttributes, toString

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

name

private String name

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

EffConfigurationItemIdentificationObject

public EffConfigurationItemIdentificationObject()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class IdentificationObject

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class IdentificationObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(EffConfigurationItemIdentificationObject thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getName

public String getName()

Gets the value of the attribute: name; The name of the configuration item is the key for all configuration item implementations.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: name; The name of the configuration item is the key for all configuration item implementations.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

newEffConfigurationItemIdentificationObject

public static EffConfigurationItemIdentificationObject newEffConfigurationItemIdentificationObject(EffConfigurationItem configItem)
                                                                                            throws WTException

The factory to be used by the configuration item's implementation of get/setIdentificationObject.

Supported API: true

Parameters:

configItem -

Returns:

EffConfigurationItemIdentificationObject

Throws:

WTException

initialize

protected void initialize(EffConfigurationItem configItem)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

configItem -

Throws:

WTException

getKeyClassName

protected String getKeyClassName()

Returns wt.eff.EffContextKey.

Supported API: false

Overrides:

getKeyClassName in class IdentificationObject

Returns:

String

getIdentity

public String getIdentity()

Constructs and returns a string representing the object's identity. This is an abstract method that must be implemented by classes extending the IdentifiactionObject class. A straightforward way of build a string representation of the identity is to concatenate the attributes that constitute the identity, using an appropriate separator.

Supported API: false

Specified by:

getIdentity in class IdentificationObject

Returns:

String

setToObject

protected void setToObject(Identified obj)
                    throws WTException

Updates the identity of the object passed as argument with the identity held in the object.

Supported API: false

Specified by:

setToObject in class IdentificationObject

Parameters:

obj -

Throws:

WTException