com.ptc.windchill.esi.bom
Class AlternateItemGroup

java.lang.Object
  wt.fc.WTObject
      wt.fc.ObjectToObjectLink
          com.ptc.windchill.esi.bom.AlternateItemGroup

All Implemented Interfaces:

BinaryLink, DisplayIdentification, Externalizable, Link, NetFactor, ObjectMappable, Persistable, Serializable

public final class AlternateItemGroup

extends ObjectToObjectLink

implements Externalizable

Represent an identifier for grouping a component and substitues on a Windchill assembly. This object is used to map a Windchill assembly to the alternate item group behavior of SAP's R3 ERP system.

Use the newAlternateItemGroup static factory method(s), not the AlternateItemGroup 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

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	LINE_NUMBER Label for the attribute; Line number is copied from part usage link when an assembly is published to ERP.
private long	lineNumber
private int	number
static String	NUMBER Label for the attribute; Identifier of a grouping of a Windchill assembly component and its substitues.
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	WTPART_MASTER_ROLE Label for the attribute.
static String	WTPART_ROLE Label for the attribute.

Fields inherited from class wt.fc.ObjectToObjectLink

ROLE_AOBJECT_REF, ROLE_BOBJECT_REF

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.BinaryLink

ALL_ROLES, BOTH_ROLES, ROLE_AOBJECT_ROLE, ROLE_BOBJECT_ROLE

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

AlternateItemGroup()

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.
String	getConceptualClassname() Deprecated.
long	getLineNumber() Gets the value of the attribute: LINE_NUMBER.
int	getNumber() Gets the value of the attribute: NUMBER.
WTPart	getWTPart() Gets the object for the association that plays role: WTPART_ROLE.
WTPartMaster	getWTPartMaster() Gets the object for the association that plays role: WTPART_MASTER_ROLE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private boolean	hasUsageLink(Persistable roleA, Persistable roleB)
protected void	initialize(Persistable aObj, Persistable bObj, int number) Supports initialization, following construction of an instance.
static AlternateItemGroup	newAlternateItemGroup(Persistable aObj, Persistable bObj, int number) Define a constructor with three arguments.
private void	numberValidate(int a_Number)
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(AlternateItemGroup thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setLineNumber(long a_LineNumber) Sets the value of the attribute: LINE_NUMBER.
void	setNumber(int a_Number) Sets the value of the attribute: NUMBER.
protected void	setWTPart(WTPart theWTPart) Sets the object for the association that plays role: WTPART_ROLE.
protected void	setWTPartMaster(WTPartMaster theWTPartMaster) Sets the object for the association that plays role: WTPART_MASTER_ROLE.
private void	validate(Persistable roleA, Persistable roleB) To ensure WTPartUsageLink object exists on assembly roleA.
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.fc.ObjectToObjectLink

appendJoinCriteria, appendRoleCriteria, duplicate, getAllObjects, getJoinValues, getLinkInfo, getObject, getOtherObject, getRemoteRoleAObjectId, getRemoteRoleBObjectId, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, getRoleIdName, getRoleObject, initialize, isRoleANonpersistentProxy, isRoleBNonpersistentProxy, readVersion, setRoleAObject, setRoleAObjectRef, setRoleBObject, setRoleBObjectRef, setRoleObject

Methods inherited from class wt.fc.WTObject

checkAttributes, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, initialize, 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, getIdentity, 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

WTPART_ROLE

public static final String WTPART_ROLE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

WTPART_MASTER_ROLE

public static final String WTPART_MASTER_ROLE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

NUMBER

public static final String NUMBER

Label for the attribute; Identifier of a grouping of a Windchill assembly component and its substitues. Must be unique on any assembly.

Supported API: true

See Also:

Constant Field Values

number

private int number

LINE_NUMBER

public static final String LINE_NUMBER

Label for the attribute; Line number is copied from part usage link when an assembly is published to ERP.

Supported API: true

See Also:

Constant Field Values

lineNumber

private long lineNumber

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

AlternateItemGroup

public AlternateItemGroup()

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 ObjectToObjectLink

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 ObjectToObjectLink

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 ObjectToObjectLink

Parameters:

input -

Throws:

SQLException

DatastoreException

getWTPart

public WTPart getWTPart()

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

Supported API: true

Returns:

WTPart

setWTPart

protected void setWTPart(WTPart theWTPart)
                  throws WTPropertyVetoException

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

Supported API: true

Parameters:

theWTPart -

Throws:

WTPropertyVetoException

getWTPartMaster

public WTPartMaster getWTPartMaster()

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

Supported API: true

Returns:

WTPartMaster

setWTPartMaster

protected void setWTPartMaster(WTPartMaster theWTPartMaster)
                        throws WTPropertyVetoException

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

Supported API: true

Parameters:

theWTPartMaster -

Throws:

WTPropertyVetoException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getNumber

public int getNumber()

Gets the value of the attribute: NUMBER. Identifier of a grouping of a Windchill assembly component and its substitues. Must be unique on any assembly.

Supported API: true

Returns:

int

setNumber

public void setNumber(int a_Number)
               throws WTPropertyVetoException

Sets the value of the attribute: NUMBER. Identifier of a grouping of a Windchill assembly component and its substitues. Must be unique on any assembly.

Supported API: true

Parameters:

a_Number -

Throws:

WTPropertyVetoException

numberValidate

private void numberValidate(int a_Number)
                     throws WTPropertyVetoException

Parameters:

a_Number -

Throws:

WTPropertyVetoException

getLineNumber

public long getLineNumber()

Gets the value of the attribute: LINE_NUMBER. Line number is copied from part usage link when an assembly is published to ERP.

Supported API: true

Returns:

long

setLineNumber

public void setLineNumber(long a_LineNumber)
                   throws WTPropertyVetoException

Sets the value of the attribute: LINE_NUMBER. Line number is copied from part usage link when an assembly is published to ERP.

Supported API: true

Parameters:

a_LineNumber -

Throws:

WTPropertyVetoException

newAlternateItemGroup

public static AlternateItemGroup newAlternateItemGroup(Persistable aObj,
                                                       Persistable bObj,
                                                       int number)
                                                throws WTException

Define a constructor with three arguments. Windchill code generator will build a factory method that accepts the three arguments and calls initialize() using those arguments.

Supported API: false

Parameters:

aObj -

bObj -

number -

Returns:

AlternateItemGroup

Throws:

WTException

initialize

protected void initialize(Persistable aObj,
                          Persistable bObj,
                          int number)
                   throws WTException

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

Supported API: false

Parameters:

aObj -

bObj -

number -

Throws:

WTException

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 ObjectToObjectLink

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 ObjectToObjectLink

Returns:

int

validate

private void validate(Persistable roleA,
                      Persistable roleB)
               throws ESIException

To ensure WTPartUsageLink object exists on assembly roleA.

Throws:

ESIException

hasUsageLink

private boolean hasUsageLink(Persistable roleA,
                             Persistable roleB)
                      throws ESIException

Throws:

ESIException