wt.folder
Class SubFolderReference

java.lang.Object
  wt.fc.ObjectReference
      wt.fc.CachedObjectReference
          wt.folder.SubFolderReference

All Implemented Interfaces:

Evolvable, Externalizable, NetFactor, ObjectMappable, Serializable, WTReference

public final class SubFolderReference

extends CachedObjectReference

implements Externalizable

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

Nested Class Summary

Nested classes inherited from class wt.fc.CachedObjectReference

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
private String	name
static String	NAME Label for the attribute.
private static int	NAME_UPPER_LIMIT
static String	OBJECT Label for the attribute.
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.CachedObjectReference

INFLATED

Fields inherited from class wt.fc.ObjectReference

KEY, object, OBJECT_ID

Constructor Summary

SubFolderReference()

Method Summary

String	getConceptualClassname() Deprecated.
String	getName() Gets the value of the attribute: NAME.
void	inflate(CachedObjectReference cor) Supported API: false
void	inflate(Persistable obj) Supported API: false
protected void	initialize(ObjectIdentifier folder_oid) Supports initialization, following construction of an instance.
protected void	initialize(SubFolder folder) Supports initialization, following construction of an instance.
protected void	initialize(SubFolderReference folder_reference) Supports initialization, following construction of an instance.
static SubFolderReference	newSubFolderReference() Supported API: false
static SubFolderReference	newSubFolderReference(ObjectIdentifier folder_oid) Default no-arg factory to construct a CabinetReference.
static SubFolderReference	newSubFolderReference(SubFolder folder) Factory to construct a CabinetReference for the supplied Cabinet.
static SubFolderReference	newSubFolderReference(SubFolderReference folder_reference) Factory to construct a CabinetReference for the supplied CabinetReference.
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(SubFolderReference thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
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 wt.fc.CachedObjectReference

deflate, getObject, getReadOnlyObject, inflate, isInflated, isObjectInflated, readVersion, refresh, reset, setInflated, setObjectNull

Methods inherited from class wt.fc.ObjectReference

equals, getClassInfo, getKey, getObjectId, getReferencedClass, getReferencedClass, hashCode, hasPersistence, initialize, initialize, initialize, newObjectReference, newObjectReference, newObjectReference, newObjectReference, readVersion, references, setKey, setObject, setObjectId

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

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

OBJECT

public static final String OBJECT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

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

SubFolderReference

public SubFolderReference()

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 CachedObjectReference

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 CachedObjectReference

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 CachedObjectReference

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

Overrides:

getConceptualClassname in class ObjectReference

Returns:

String

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: false

Returns:

String

newSubFolderReference

public static SubFolderReference newSubFolderReference()
                                                throws WTException

Supported API: false

Returns:

SubFolderReference

Throws:

WTException

newSubFolderReference

public static SubFolderReference newSubFolderReference(ObjectIdentifier folder_oid)
                                                throws WTException

Default no-arg factory to construct a CabinetReference.

Supported API: false

Parameters:

folder_oid -

Returns:

SubFolderReference

Throws:

WTException

initialize

protected void initialize(ObjectIdentifier folder_oid)
                   throws WTException

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

Supported API: false

Overrides:

initialize in class ObjectReference

Parameters:

folder_oid -

Throws:

WTException

newSubFolderReference

public static SubFolderReference newSubFolderReference(SubFolder folder)
                                                throws WTException

Factory to construct a CabinetReference for the supplied Cabinet.

Supported API: false

Parameters:

folder -

Returns:

SubFolderReference

Throws:

WTException

initialize

protected void initialize(SubFolder folder)
                   throws WTException

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

Supported API: false

Parameters:

folder -

Throws:

WTException

newSubFolderReference

public static SubFolderReference newSubFolderReference(SubFolderReference folder_reference)
                                                throws WTException

Factory to construct a CabinetReference for the supplied CabinetReference.

Supported API: false

Parameters:

folder_reference -

Returns:

SubFolderReference

Throws:

WTException

initialize

protected void initialize(SubFolderReference folder_reference)
                   throws WTException

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

Supported API: false

Parameters:

folder_reference -

Throws:

WTException

inflate

public void inflate(Persistable obj)

Supported API: false

Specified by:

inflate in class CachedObjectReference

Parameters:

obj -

inflate

public void inflate(CachedObjectReference cor)

Supported API: false

Specified by:

inflate in class CachedObjectReference

Parameters:

cor -

toString

public String toString()

Description copied from class: ObjectReference

Returns a String representation of the object being referenced.

Supported API: false

Overrides:

toString in class ObjectReference

Returns:

String