wt.epm.supportingdata
Class EPMSupportingData

java.lang.Object
  wt.epm.supportingdata.EPMSupportingData

All Implemented Interfaces:

Externalizable, Serializable, EPMObject, NetFactor, ObjectMappable, Persistable, wt.iba.value.IBAHolder

public final class EPMSupportingData
extends Object
implements Persistable, EPMObject, wt.iba.value.IBAHolder, Externalizable

Applications may save data that is specific to their applications inside an EPMSupportingData object.They save their data in the data member of the object.
An EPMSupportingData Holder distinquishes between EPMSupportingData objects that it holds by their names and the application that they belong to. Applications must assign a unique name to each EPMSupportingData object that they add.
For all EPMSupportingData objects that belong to the same EPMSupportingData Holder, the pair, ownerApplication and name must be unique. A uniqueness constraint on the database table for EPMSupportingData enforces this requirement. As a result, the EPMSupportingData class must be made Final. We chose this approach over the creation of a seperate identification class in order to prevent the creation of an additional database table for the identification class.

In order to facilitate future migration, it is recommended that the data object implements Evolvable.

Use the newEPMSupportingData static factory method(s), not the EPMSupportingData 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:

Serialized Form

Field Summary

static String	AUTHORING_APP_VERSION Label for the attribute.
static String	AUTHORING_APP_VERSION_REFERENCE Label for the attribute.
static String	AUTHORING_APPLICATION Label for the attribute; Indicates that the named application authored the object.
static String	DESCRIPTION Label for the attribute; A user-specified description field.
static String	OWNER_APPLICATION Label for the attribute; Indicate that the named application owns the object.

Method Summary

EPMAuthoringAppType	getAuthoringApplication() Gets the value of the attribute: AUTHORING_APPLICATION.
EPMAuthoringAppVersion	getAuthoringAppVersion() Gets the object for the association that plays role: AUTHORING_APP_VERSION.
wt.epm.EPMAuthAppVersionRef	getAuthoringAppVersionReference() Gets the value of the attribute: AUTHORING_APP_VERSION_REFERENCE.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
EPMApplicationType	getOwnerApplication() Gets the value of the attribute: OWNER_APPLICATION.
protected void	initialize(String name, EPMAuthoringAppType authoringApp, Object data, EPMSupportingDataHolder holder) Supports initialization, following construction of an instance.
static EPMSupportingData	newEPMSupportingData(String name, EPMAuthoringAppType authoringApp, Object data, EPMSupportingDataHolder holder) Supported API: true
void	setAuthoringApplication(EPMAuthoringAppType a_AuthoringApplication) Sets the value of the attribute: AUTHORING_APPLICATION.
void	setAuthoringAppVersion(EPMAuthoringAppVersion a_AuthoringAppVersion) Sets the object for the association that plays role: AUTHORING_APP_VERSION.
void	setAuthoringAppVersionReference(wt.epm.EPMAuthAppVersionRef a_AuthoringAppVersionReference) Sets the value of the attribute: AUTHORING_APP_VERSION_REFERENCE.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setOwnerApplication(EPMApplicationType a_OwnerApplication) Sets the value of the attribute: OWNER_APPLICATION.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute; A user-specified description field.

Supported API: true

See Also:

Constant Field Values

OWNER_APPLICATION

public static final String OWNER_APPLICATION

Label for the attribute; Indicate that the named application owns the object.

The parameter is an EPMApplicationType, so that any sort of checking can be done at run-time.

Supported API: true

See Also:

Constant Field Values

AUTHORING_APPLICATION

public static final String AUTHORING_APPLICATION

Label for the attribute; Indicates that the named application authored the object.

The parameter is an EPMAuthoringAppType, so that any sort of checking can be done at run-time.

Supported API: true

See Also:

Constant Field Values

AUTHORING_APP_VERSION

public static final String AUTHORING_APP_VERSION

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

AUTHORING_APP_VERSION_REFERENCE

public static final String AUTHORING_APP_VERSION_REFERENCE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. A user-specified description field.

Supported API: true

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. A user-specified description field.

Supported API: true

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getOwnerApplication

public EPMApplicationType getOwnerApplication()

Gets the value of the attribute: OWNER_APPLICATION. Indicate that the named application owns the object.

The parameter is an EPMApplicationType, so that any sort of checking can be done at run-time.

Supported API: true

Specified by:

getOwnerApplication in interface EPMObject

Returns:

EPMApplicationType

setOwnerApplication

public void setOwnerApplication(EPMApplicationType a_OwnerApplication)
                         throws WTPropertyVetoException

Sets the value of the attribute: OWNER_APPLICATION. Indicate that the named application owns the object.

The parameter is an EPMApplicationType, so that any sort of checking can be done at run-time.

Supported API: true

Parameters:

a_OwnerApplication -

Throws:

WTPropertyVetoException

getAuthoringApplication

public EPMAuthoringAppType getAuthoringApplication()

Gets the value of the attribute: AUTHORING_APPLICATION. Indicates that the named application authored the object.

The parameter is an EPMAuthoringAppType, so that any sort of checking can be done at run-time.

Supported API: true

Specified by:

getAuthoringApplication in interface EPMObject

Returns:

EPMAuthoringAppType

setAuthoringApplication

public void setAuthoringApplication(EPMAuthoringAppType a_AuthoringApplication)
                             throws WTPropertyVetoException

Sets the value of the attribute: AUTHORING_APPLICATION. Indicates that the named application authored the object.

The parameter is an EPMAuthoringAppType, so that any sort of checking can be done at run-time.

Supported API: true

Parameters:

a_AuthoringApplication -

Throws:

WTPropertyVetoException

getAuthoringAppVersion

public EPMAuthoringAppVersion getAuthoringAppVersion()

Gets the object for the association that plays role: AUTHORING_APP_VERSION.

Supported API: true

Returns:

EPMAuthoringAppVersion

setAuthoringAppVersion

public void setAuthoringAppVersion(EPMAuthoringAppVersion a_AuthoringAppVersion)
                            throws WTPropertyVetoException,
                                   WTException

Sets the object for the association that plays role: AUTHORING_APP_VERSION.

Supported API: true

Parameters:

a_AuthoringAppVersion -

Throws:

WTPropertyVetoException

WTException

getAuthoringAppVersionReference

public wt.epm.EPMAuthAppVersionRef getAuthoringAppVersionReference()

Gets the value of the attribute: AUTHORING_APP_VERSION_REFERENCE.

Supported API: true

Returns:

EPMAuthAppVersionRef

setAuthoringAppVersionReference

public void setAuthoringAppVersionReference(wt.epm.EPMAuthAppVersionRef a_AuthoringAppVersionReference)
                                     throws WTPropertyVetoException

Sets the value of the attribute: AUTHORING_APP_VERSION_REFERENCE.

Supported API: true

Parameters:

a_AuthoringAppVersionReference -

Throws:

WTPropertyVetoException

newEPMSupportingData

public static EPMSupportingData newEPMSupportingData(String name,
                                                     EPMAuthoringAppType authoringApp,
                                                     Object data,
                                                     EPMSupportingDataHolder holder)
                                              throws WTException

Supported API: true

Parameters:

name -

authoringApp -

data -

holder -

Returns:

EPMSupportingData

Throws:

WTException

initialize

protected void initialize(String name,
                          EPMAuthoringAppType authoringApp,
                          Object data,
                          EPMSupportingDataHolder holder)
                   throws WTException

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

Supported API: true

Parameters:

name -

authoringApp -

data -

holder -

Throws:

WTException