wt.fc
Class ObjectReference

java.lang.Object
  wt.fc.ObjectReference

All Implemented Interfaces:

Evolvable, Externalizable, NetFactor, ObjectMappable, Serializable, WTReference

Direct Known Subclasses:

AttributeDefinitionReference, AttributeDefReference, CachedObjectReference, ConfigurationItemReference, IBAHolderReference, IBAReferenceableReference, NodeReference, ObjectReferenceOidHolder, RefreshHelper.RoleObjectReference, TeamReference, WTPrincipalReference

public class ObjectReference

extends Object

implements WTReference, Evolvable

Holds a reference to a Persistable object by means of the object's ObjectIdentifier.

Use the newObjectReference static factory method(s), not the ObjectReference 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 ObjectIdentifier	key
static String	KEY Label for the attribute.
protected Persistable	object
static String	OBJECT_ID Deprecated. replaced by KEY
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from interface wt.fc.WTReference

OBJECT

Constructor Summary

ObjectReference()

Method Summary

void	deflate() Supported API: false
boolean	equals(Object obj) Supported API: false
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
QueryKey	getKey() Gets the object for the association that plays role: KEY.
Persistable	getObject() Gets the object for the association that plays role: OBJECT.
ObjectIdentifier	getObjectId() Deprecated. replaced by getKey
Class	getReferencedClass() Returns the class that this reference refers to.
static Class	getReferencedClass(QueryKey key, Persistable object) Precondition: Either the object is non-null or the key has a valid, fully qualified class name.
int	hashCode() Supported API: false
boolean	hasPersistence() Determines if this reference is currently storing an inflated, persisted object
protected void	initialize() Deprecated.
protected void	initialize(ObjectIdentifier objId) Supports initialization, following construction of an instance.
protected void	initialize(ObjectReference objectReference) Supports initialization, following construction of an instance.
protected void	initialize(Persistable obj) Supported API: false
boolean	isObjectInflated() Determines if this reference contains an inflated Persistable.
static ObjectReference	newObjectReference() Deprecated. Since R5. This constructor should no longer be used because it is not valid to have an ObjectReference unless it refers to an object.
static ObjectReference	newObjectReference(ObjectIdentifier objId) Constructs a reference to the object identified by an ObjectIdentifier.
static ObjectReference	newObjectReference(ObjectReference objectReference) Constructs a reference to the object referred to by another ObjectReference.
static ObjectReference	newObjectReference(Persistable obj) Constructs a reference to a Persistable object.
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(ObjectReference thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
boolean	references(Persistable obj) Supported API: false
void	refresh() Supported API: false
void	setKey(QueryKey a_Key) Sets the object for the association that plays role: KEY.
void	setObject(Persistable a_Object) Changes the object referred to by this ObjectReference.
void	setObjectId(ObjectIdentifier a_ObjectId) Deprecated. replaced by setKey
String	toString() Returns a String representation of the object being referenced.
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

OBJECT_ID

public static final String OBJECT_ID

Deprecated. replaced by KEY

Label for the attribute;

Supported API: false

See Also:

Constant Field Values

KEY

public static final String KEY

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

key

private ObjectIdentifier key

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

object

protected Persistable object

Constructor Detail

ObjectReference

public ObjectReference()

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(ObjectReference 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 a String representation of the object being referenced.

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

getObjectId

public ObjectIdentifier getObjectId()

Deprecated. replaced by getKey

Gets the value of the attribute: OBJECT_ID.

Supported API: false

Returns:

ObjectIdentifier

setObjectId

public void setObjectId(ObjectIdentifier a_ObjectId)

Deprecated. replaced by setKey

Sets the value of the attribute: OBJECT_ID.

Supported API: false

Parameters:

a_ObjectId -

newObjectReference

public static ObjectReference newObjectReference()
                                          throws WTException

Deprecated. Since R5. This constructor should no longer be used because it is not valid to have an ObjectReference unless it refers to an object.

Supported API: false

Returns:

ObjectReference

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

Deprecated.

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

Supported API: false

Throws:

WTException

newObjectReference

public static ObjectReference newObjectReference(Persistable obj)
                                          throws WTException

Constructs a reference to a Persistable object.

Supported API: false

Parameters:

obj -

Returns:

ObjectReference

Throws:

WTException

newObjectReference

public static ObjectReference newObjectReference(ObjectIdentifier objId)
                                          throws WTException

Constructs a reference to the object identified by an ObjectIdentifier.

Supported API: false

Parameters:

objId -

Returns:

ObjectReference

Throws:

WTException

initialize

protected void initialize(ObjectIdentifier objId)
                   throws WTException

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

Supported API: false

Parameters:

objId -

Throws:

WTException

newObjectReference

public static ObjectReference newObjectReference(ObjectReference objectReference)
                                          throws WTException

Constructs a reference to the object referred to by another ObjectReference.

Supported API: false

Parameters:

objectReference -

Returns:

ObjectReference

Throws:

WTException

initialize

protected void initialize(ObjectReference objectReference)
                   throws WTException

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

Supported API: false

Parameters:

objectReference -

Throws:

WTException

deflate

public void deflate()
             throws WTException

Supported API: false

Throws:

WTException

equals

public boolean equals(Object obj)

Supported API: false

Specified by:

equals in interface WTReference

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Supported API: false

Specified by:

hashCode in interface WTReference

Returns:

int

refresh

public void refresh()
             throws WTException

Supported API: false

Specified by:

refresh in interface WTReference

Throws:

WTException

references

public boolean references(Persistable obj)

Supported API: false

Specified by:

references in interface WTReference

Parameters:

obj -

Returns:

boolean

setObject

public void setObject(Persistable a_Object)

Changes the object referred to by this ObjectReference.

Supported API: false

Parameters:

a_Object -

getReferencedClass

public static Class getReferencedClass(QueryKey key,
                                       Persistable object)

Precondition: Either the object is non-null or the key has a valid, fully qualified class name.

Returns the class of the object passed in, or if null the class defined by the QueryKey passed in. Null is returned if the QueryKey is null or the class specified by the key is invalid.

Supported API: false

Parameters:

key -

object -

Returns:

Class

initialize

protected void initialize(Persistable obj)
                   throws WTException

Supported API: false

Parameters:

obj -

Throws:

WTException

getReferencedClass

public Class getReferencedClass()

Returns the class that this reference refers to. This method does not retreive the referenced object from the database.

Supported API: false

Specified by:

getReferencedClass in interface WTReference

Returns:

Class

getObject

public Persistable getObject()
                      throws WTRuntimeException

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

Supported API: false

Specified by:

getObject in interface WTReference

Returns:

Persistable

Throws:

WTRuntimeException

getKey

public QueryKey getKey()

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

Supported API: false

Specified by:

getKey in interface WTReference

Returns:

QueryKey

setKey

public void setKey(QueryKey a_Key)

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

Supported API: false

Specified by:

setKey in interface WTReference

Parameters:

a_Key -

hasPersistence

public boolean hasPersistence()

Determines if this reference is currently storing an inflated, persisted object

Returns:

boolean

isObjectInflated

public boolean isObjectInflated()

Determines if this reference contains an inflated Persistable. The Persistable may or may not be persisted.

Returns:

boolean