wt.csm.businessentity
Class BusinessEntity

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.csm.businessentity.BusinessEntity

All Implemented Interfaces:

AccessControlled, BusinessInformation, DisplayIdentification, DomainAdministered, Externalizable, IBAHolder, IBAReferenceable, NetFactor, Notifiable, ObjectMappable, Persistable, Serializable

public class BusinessEntity

extends Simple

implements IBAReferenceable, IBAHolder, Externalizable

Use the newBusinessEntity static factory method(s), not the BusinessEntity 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: true

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private String	id
static String	ID Label for the attribute.
private static int	ID_UPPER_LIMIT
private String	name
static String	NAME Label for the attribute.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private AttributeContainer	theAttributeContainer

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.iba.value.IBAHolder

ATTRIBUTE_CONTAINER

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

BusinessEntity()

Method Summary

boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
AttributeContainer	getAttributeContainer() Gets the object for the association that plays role: ATTRIBUTE_CONTAINER.
String	getConceptualClassname() Deprecated.
String	getIBAReferenceableDisplayString() Supported API: false
String	getId() Gets the value of the attribute: ID.
String	getIdentity() Gets the value of the attribute: IDENTITY.
String	getName() Gets the value of the attribute: NAME.
String	getReferenceID() Supported API: false
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private void	idValidate(String a_Id)
protected void	initialize(String name) Supports initialization, following construction of an instance.
private void	nameValidate(String a_Name)
static BusinessEntity	newBusinessEntity() Supported API: false
static BusinessEntity	newBusinessEntity(String name) Supported API: false
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
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(BusinessEntity thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAttributeContainer(AttributeContainer a_AttributeContainer) Sets the object for the association that plays role: ATTRIBUTE_CONTAINER.
void	setId(String a_Id) Sets the value of the attribute: ID.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.enterprise.Simple

getBusinessType, getDomainRef, getEventSet, initialize, isInheritedDomain, readVersion, setDomainRef, setEventSet, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.Persistable

checkAttributes, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

NAME

public static final String NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

ID

public static final String ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ID_UPPER_LIMIT

private static int ID_UPPER_LIMIT

id

private String id

theAttributeContainer

private AttributeContainer theAttributeContainer

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

BusinessEntity

public BusinessEntity()

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 Simple

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 Simple

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(BusinessEntity 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

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class Simple

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class Simple

Parameters:

input -

Throws:

SQLException

DatastoreException

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.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getId

public String getId()

Gets the value of the attribute: ID.

Supported API: false

Returns:

String

setId

public void setId(String a_Id)
           throws WTPropertyVetoException

Sets the value of the attribute: ID.

Supported API: false

Parameters:

a_Id -

Throws:

WTPropertyVetoException

idValidate

private void idValidate(String a_Id)
                 throws WTPropertyVetoException

Parameters:

a_Id -

Throws:

WTPropertyVetoException

newBusinessEntity

public static BusinessEntity newBusinessEntity()
                                        throws WTException

Supported API: false

Returns:

BusinessEntity

Throws:

WTException

newBusinessEntity

public static BusinessEntity newBusinessEntity(String name)
                                        throws WTException

Supported API: false

Parameters:

name -

Returns:

BusinessEntity

Throws:

WTException

initialize

protected void initialize(String name)
                   throws WTException

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

Supported API: false

Parameters:

name -

Throws:

WTException

getIBAReferenceableDisplayString

public String getIBAReferenceableDisplayString()

Supported API: false

Specified by:

getIBAReferenceableDisplayString in interface IBAReferenceable

Returns:

String

getReferenceID

public String getReferenceID()

Supported API: false

Specified by:

getReferenceID in interface IBAReferenceable

Returns:

String

getAttributeContainer

public AttributeContainer getAttributeContainer()

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

Supported API: false

Specified by:

getAttributeContainer in interface IBAHolder

Returns:

AttributeContainer

setAttributeContainer

public void setAttributeContainer(AttributeContainer a_AttributeContainer)

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

Supported API: false

Specified by:

setAttributeContainer in interface IBAHolder

Parameters:

a_AttributeContainer -

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class Simple

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class Simple

Returns:

int

getIdentity

public String getIdentity()

Description copied from interface: Persistable

Gets the value of the attribute: IDENTITY. Supplies the identity of the object for business purposes. The identity is composed of name, number or possibly other attributes. The identity does not include the type of the object.

Supported API: false

Specified by:

getIdentity in interface Persistable

Overrides:

getIdentity in class Simple

Returns:

String