wt.epm.build
Class EPMBuildRule

java.lang.Object
  wt.fc.WTObject
      wt.vc.VersionToVersionLink
          wt.epm.build.EPMBuildRule

All Implemented Interfaces:

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

Direct Known Subclasses:

EPMBuildLinksRule

public abstract class EPMBuildRule

extends VersionToVersionLink

implements EPMObject, BuildRule, Externalizable

This class is non-supported and may be removed at any time. Decides what data from the build source to publish to the build target and how to publish them.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

static String	BUILD_SOURCE_ROLE Label for the attribute.
static String	BUILD_TARGET_ROLE Label for the attribute.
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
static long	R70_EXTERNALIZATION_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	UNIQUE_ID Label for the attribute; A unique ID, automatically maintained by the system, that distinguishes one build rule from another.
private long	uniqueID

Fields inherited from class wt.vc.VersionToVersionLink

ROLE_AOBJECT_REF, ROLE_BOBJECT_REF

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.epm.EPMObject

AUTHORING_APPLICATION, OWNER_APPLICATION, UNSPECIFIED

Fields inherited from interface wt.fc.BinaryLink

ALL_ROLES, BOTH_ROLES, ROLE_AOBJECT_REF, ROLE_AOBJECT_ROLE, ROLE_BOBJECT_REF, 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

EPMBuildRule()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
abstract String	getApplicationTag() Supported API: false
EPMAuthoringAppType	getAuthoringApplication() Gets the value of the attribute: AUTHORING_APPLICATION.
BuildSource	getBuildSource() The getBuildSource method is required by the BuildRule interface.But, the code generator does not add it.
BuildTarget	getBuildTarget() The getBuildTarget method is required by the BuildRule interface.But, the code generator does not add it.
EPMApplicationType	getOwnerApplication() Gets the value of the attribute: OWNER_APPLICATION.
long	getUniqueID() Gets the value of the attribute: UNIQUE_ID.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(EPMDocument source, WTPart target) 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(EPMBuildRule thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setBuildSource(BuildSource source) The setBuildSource method is required by the BuildRule interface.But, the code generator does not add it.
void	setBuildTarget(BuildTarget target) The setBuildTarget method is required by the BuildRule interface.But, the code generator does not add it.
void	setUniqueID(long a_UniqueID) Sets the value of the attribute: UNIQUE_ID.
private void	uniqueIDValidate(long a_UniqueID)
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.vc.VersionToVersionLink

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

Methods inherited from class wt.fc.WTObject

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.BinaryLink

getLinkInfo, getObject, getOtherObject, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, setRoleAObject, setRoleAObjectRef, setRoleBObject, setRoleBObjectRef

Methods inherited from interface wt.fc.Link

appendJoinCriteria, appendRoleCriteria, getAllObjects, getJoinValues, getRoleIdName, getRoleObject, setRoleObject

Methods inherited from interface wt.fc.Persistable

getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

BUILD_SOURCE_ROLE

public static final String BUILD_SOURCE_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

BUILD_TARGET_ROLE

public static final String BUILD_TARGET_ROLE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

UNIQUE_ID

public static final String UNIQUE_ID

Label for the attribute; A unique ID, automatically maintained by the system, that distinguishes one build rule from another.

Supported API: true

See Also:

Constant Field Values

uniqueID

private long uniqueID

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

R70_EXTERNALIZATION_VERSION_UID

public static final long R70_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

EPMBuildRule

public EPMBuildRule()

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 VersionToVersionLink

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 VersionToVersionLink

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 VersionToVersionLink

Parameters:

input -

Throws:

SQLException

DatastoreException

getUniqueID

public long getUniqueID()

Gets the value of the attribute: UNIQUE_ID. A unique ID, automatically maintained by the system, that distinguishes one build rule from another.

Supported API: true

Returns:

long

setUniqueID

public void setUniqueID(long a_UniqueID)
                 throws WTPropertyVetoException

Sets the value of the attribute: UNIQUE_ID. A unique ID, automatically maintained by the system, that distinguishes one build rule from another.

Supported API: true

Parameters:

a_UniqueID -

Throws:

WTPropertyVetoException

uniqueIDValidate

private void uniqueIDValidate(long a_UniqueID)
                       throws WTPropertyVetoException

Parameters:

a_UniqueID -

Throws:

WTPropertyVetoException

getApplicationTag

public abstract String getApplicationTag()

Supported API: false

Returns:

String

initialize

protected void initialize(EPMDocument source,
                          WTPart target)
                   throws WTException

Supported API: false

Parameters:

source -

target -

Throws:

WTException

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

In particular, this must check that the modifications to the object were made by an approved application.

Supported API: false

Specified by:

checkAttributes in interface EPMObject

Overrides:

checkAttributes in class WTObject

Throws:

InvalidAttributeException

getBuildSource

public BuildSource getBuildSource()

The getBuildSource method is required by the BuildRule interface.But, the code generator does not add it. So, we modeled it directly.

Supported API: false

Specified by:

getBuildSource in interface BuildRule

Returns:

BuildSource

setBuildSource

public void setBuildSource(BuildSource source)
                    throws WTPropertyVetoException

The setBuildSource method is required by the BuildRule interface.But, the code generator does not add it. So, we modeled it directly.

Supported API: false

Specified by:

setBuildSource in interface BuildRule

Parameters:

source -

Throws:

WTPropertyVetoException

getBuildTarget

public BuildTarget getBuildTarget()

The getBuildTarget method is required by the BuildRule interface.But, the code generator does not add it. So, we modeled it directly.

Supported API: false

Specified by:

getBuildTarget in interface BuildRule

Returns:

BuildTarget

setBuildTarget

public void setBuildTarget(BuildTarget target)
                    throws WTPropertyVetoException

The setBuildTarget method is required by the BuildRule interface.But, the code generator does not add it. So, we modeled it directly.

Supported API: false

Specified by:

setBuildTarget in interface BuildRule

Parameters:

target -

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

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

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 VersionToVersionLink

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 VersionToVersionLink

Returns:

int