wt.ufid
Class RemoteObjectInfo

java.lang.Object
  wt.ufid.RemoteObjectInfo

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class RemoteObjectInfo

extends Object

implements Persistable, Externalizable

Use the newRemoteObjectInfo static factory method(s), not the RemoteObjectInfo 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: false

Extendable: false

See Also:

Serialized Form

Field Summary

static String	BIRTH_ID Label for the attribute.
private long	birthId
private Repository	birthRepository
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	LAST_KNOWN_ID Label for the attribute.
private long	lastKnownId
private Repository	lastKnownRepository
static String	LOCAL_OBJECT Label for the attribute.
static String	LOCAL_OBJECT_REFERENCE Label for the attribute.
private ObjectReference	localObjectReference
protected static long	OLD_FORMAT_VERSION_UID
static String	REMOTE_OBJECT_ID Label for the attribute.
private static int	REMOTE_OBJECT_ID_UPPER_LIMIT
private String	remoteObjectId
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

RemoteObjectInfo()

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.
long	getBirthId() Gets the value of the attribute: BIRTH_ID.
Repository	getBirthRepository() Supported API: false
Repository	getBirthRepositoryForMigration(PersistentObjectManager pom) Answer the getBirthRepository of the current system.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
String	getIdentity() Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().
long	getLastKnownId() Gets the value of the attribute: LAST_KNOWN_ID.
Repository	getLastKnownRepository() Supported API: false
Federatable	getLocalObject() Gets the object for the association that plays role: LOCAL_OBJECT.
ObjectReference	getLocalObjectReference() Gets the value of the attribute: LOCAL_OBJECT_REFERENCE.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
String	getRemoteObjectId() Gets the value of the attribute: REMOTE_OBJECT_ID.
String	getType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(Federatable object, Repository birthRepos, Repository lastRepos) Supports initialization, following construction of an instance.
protected void	initialize(String objectId, Repository birthRepos, Repository lastRepos) Supports initialization, following construction of an instance.
private void	localObjectReferenceValidate(ObjectReference a_LocalObjectReference)
static RemoteObjectInfo	newRemoteObjectInfo(Federatable object, Repository birthRepos, Repository lastRepos) Supported API: false
static RemoteObjectInfo	newRemoteObjectInfo(String objectId, Repository birthRepos, Repository lastRepos) 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(RemoteObjectInfo thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	remoteObjectIdValidate(String a_RemoteObjectId)
void	setBirthId(long a_BirthId) Sets the value of the attribute: BIRTH_ID.
void	setBirthRepository(Repository repos) Supported API: false
void	setLastKnownId(long a_LastKnownId) Sets the value of the attribute: LAST_KNOWN_ID.
void	setLastKnownRepository(Repository repos) Supported API: false
void	setLocalObject(Federatable a_LocalObject) Sets the object for the association that plays role: LOCAL_OBJECT.
void	setLocalObjectReference(ObjectReference a_LocalObjectReference) Sets the value of the attribute: LOCAL_OBJECT_REFERENCE.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
void	setRemoteObjectId(String a_RemoteObjectId) Sets the value of the attribute: REMOTE_OBJECT_ID.
String	toString() Returns the conceptual (modeled) name for the class.
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 java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

REMOTE_OBJECT_ID

public static final String REMOTE_OBJECT_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

REMOTE_OBJECT_ID_UPPER_LIMIT

private static int REMOTE_OBJECT_ID_UPPER_LIMIT

remoteObjectId

private String remoteObjectId

BIRTH_ID

public static final String BIRTH_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

birthId

private long birthId

LAST_KNOWN_ID

public static final String LAST_KNOWN_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

lastKnownId

private long lastKnownId

LOCAL_OBJECT

public static final String LOCAL_OBJECT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

LOCAL_OBJECT_REFERENCE

public static final String LOCAL_OBJECT_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

localObjectReference

private ObjectReference localObjectReference

thePersistInfo

private PersistInfo thePersistInfo

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

birthRepository

private Repository birthRepository

lastKnownRepository

private Repository lastKnownRepository

Constructor Detail

RemoteObjectInfo

public RemoteObjectInfo()

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

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

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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

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

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getRemoteObjectId

public String getRemoteObjectId()

Gets the value of the attribute: REMOTE_OBJECT_ID.

Supported API: false

Returns:

String

setRemoteObjectId

public void setRemoteObjectId(String a_RemoteObjectId)
                       throws WTPropertyVetoException

Sets the value of the attribute: REMOTE_OBJECT_ID.

Supported API: false

Parameters:

a_RemoteObjectId -

Throws:

WTPropertyVetoException

remoteObjectIdValidate

private void remoteObjectIdValidate(String a_RemoteObjectId)
                             throws WTPropertyVetoException

Parameters:

a_RemoteObjectId -

Throws:

WTPropertyVetoException

getBirthId

public long getBirthId()

Gets the value of the attribute: BIRTH_ID.

Supported API: false

Returns:

long

setBirthId

public void setBirthId(long a_BirthId)
                throws WTPropertyVetoException

Sets the value of the attribute: BIRTH_ID.

Supported API: false

Parameters:

a_BirthId -

Throws:

WTPropertyVetoException

getLastKnownId

public long getLastKnownId()

Gets the value of the attribute: LAST_KNOWN_ID.

Supported API: false

Returns:

long

setLastKnownId

public void setLastKnownId(long a_LastKnownId)
                    throws WTPropertyVetoException

Sets the value of the attribute: LAST_KNOWN_ID.

Supported API: false

Parameters:

a_LastKnownId -

Throws:

WTPropertyVetoException

getLocalObject

public Federatable getLocalObject()

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

Supported API: false

Returns:

Federatable

setLocalObject

public void setLocalObject(Federatable a_LocalObject)
                    throws WTPropertyVetoException,
                           WTException

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

Supported API: false

Parameters:

a_LocalObject -

Throws:

WTPropertyVetoException

WTException

getLocalObjectReference

public ObjectReference getLocalObjectReference()

Gets the value of the attribute: LOCAL_OBJECT_REFERENCE.

Supported API: false

Returns:

ObjectReference

setLocalObjectReference

public void setLocalObjectReference(ObjectReference a_LocalObjectReference)
                             throws WTPropertyVetoException

Sets the value of the attribute: LOCAL_OBJECT_REFERENCE.

Supported API: false

Parameters:

a_LocalObjectReference -

Throws:

WTPropertyVetoException

localObjectReferenceValidate

private void localObjectReferenceValidate(ObjectReference a_LocalObjectReference)
                                   throws WTPropertyVetoException

Parameters:

a_LocalObjectReference -

Throws:

WTPropertyVetoException

newRemoteObjectInfo

public static RemoteObjectInfo newRemoteObjectInfo(String objectId,
                                                   Repository birthRepos,
                                                   Repository lastRepos)
                                            throws WTException

Supported API: false

Parameters:

objectId -

birthRepos -

lastRepos -

Returns:

RemoteObjectInfo

Throws:

WTException

initialize

protected void initialize(String objectId,
                          Repository birthRepos,
                          Repository lastRepos)
                   throws WTException

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

Supported API: false

Parameters:

objectId -

birthRepos -

lastRepos -

Throws:

WTException

newRemoteObjectInfo

public static RemoteObjectInfo newRemoteObjectInfo(Federatable object,
                                                   Repository birthRepos,
                                                   Repository lastRepos)
                                            throws WTException

Supported API: false

Parameters:

object -

birthRepos -

lastRepos -

Returns:

RemoteObjectInfo

Throws:

WTException

initialize

protected void initialize(Federatable object,
                          Repository birthRepos,
                          Repository lastRepos)
                   throws WTException

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

Supported API: false

Parameters:

object -

birthRepos -

lastRepos -

Throws:

WTException

getBirthRepository

public Repository getBirthRepository()

Supported API: false

Returns:

Repository

getLastKnownRepository

public Repository getLastKnownRepository()

Supported API: false

Returns:

Repository

setBirthRepository

public void setBirthRepository(Repository repos)
                        throws UfidException

Supported API: false

Parameters:

repos -

Throws:

UfidException

setLastKnownRepository

public void setLastKnownRepository(Repository repos)
                            throws UfidException

Supported API: false

Parameters:

repos -

Throws:

UfidException

getIdentity

public String getIdentity()

Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().

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

Returns:

String

getType

public String getType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getType in interface Persistable

Returns:

String

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Throws:

InvalidAttributeException

getPersistInfo

public PersistInfo getPersistInfo()

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

Supported API: false

Specified by:

getPersistInfo in interface Persistable

Returns:

PersistInfo

setPersistInfo

public void setPersistInfo(PersistInfo a_PersistInfo)

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

Supported API: false

Specified by:

setPersistInfo in interface Persistable

Parameters:

a_PersistInfo -

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

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

Returns:

int

getBirthRepositoryForMigration

public Repository getBirthRepositoryForMigration(PersistentObjectManager pom)
                                          throws WTException

Answer the getBirthRepository of the current system. This method is for migration only.

Supported API: false

Returns:

Repository

Throws:

WTException