wt.folder
Class SubFolderLinkIdentity

java.lang.Object
  extended bywt.fc.IdentificationObject
      extended bywt.folder.SubFolderLinkIdentity
All Implemented Interfaces:
Externalizable, NetFactor, Serializable

public final class SubFolderLinkIdentity
extends IdentificationObject
implements Externalizable

Class that defines the uniquness constraint for a SubFolder.

Use the newSubFolderLinkIdentity static factory method(s), not the SubFolderLinkIdentity 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:
SubFolderLink, SubFolderLinkConstraint, Serialized Form

Field Summary
private static String CLASSNAME
           
static long EXTERNALIZATION_VERSION_UID
           
private static String KEY_CLASS_NAME
           
protected static long OLD_FORMAT_VERSION_UID
           
private  ObjectReference parentFolderReference
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
private  String subFolderName
           
 
Fields inherited from class wt.fc.IdentificationObject
 
Constructor Summary
SubFolderLinkIdentity()
           
 
Method Summary
 String getConceptualClassname()
          Deprecated.  
 String getIdentity()
          Returns the internal uniquness value for a SubFolderLink.
protected  String getKeyClassName()
          Returns the name of the class (table) that provides the uniqueness constraint for a SubFolderLink.
 ObjectReference getParentFolderReference()
          Gets the value of the attribute: parentFolderReference; Reference to the parent Folder.
 String getSubFolderName()
          Gets the value of the attribute: subFolderName; Name of the SubFolder.
protected  void initialize(SubFolderLink link)
          Supports initialization, following construction of an instance.
protected static SubFolderLinkIdentity newSubFolderLinkIdentity(SubFolderLink link)
          Factory to construct the object.
 void readExternal(ObjectInput input)
          Reads the non-transient fields of this class from an external source.
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(SubFolderLinkIdentity thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setParentFolderReference(ObjectReference a_ParentFolderReference)
          Sets the value of the attribute: parentFolderReference; Reference to the parent Folder.
 void setSubFolderName(String a_SubFolderName)
          Sets the value of the attribute: subFolderName; Name of the SubFolder.
 void setToObject(Identified obj)
          Method to change the the SubFolderLink when uniqueness is changed (eg the SubFolder is move to a new Folder.)

Supported API: false
 void writeExternal(ObjectOutput output)
          Writes the non-transient fields of this class to an external source.
 
Methods inherited from class wt.fc.IdentificationObject
changeIdentity, checkIdentity, createKey, getClassInfo, getSemanticKey, initialize, readVersion, setAdditionalKeyAttributes, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

KEY_CLASS_NAME

private static final String KEY_CLASS_NAME

subFolderName

private String subFolderName

parentFolderReference

private ObjectReference parentFolderReference

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

SubFolderLinkIdentity

public SubFolderLinkIdentity()
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 IdentificationObject
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 IdentificationObject
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

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

getConceptualClassname

public String getConceptualClassname()
Deprecated.  

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:
getConceptualClassname in interface NetFactor
Returns:
String

getSubFolderName

public String getSubFolderName()
Gets the value of the attribute: subFolderName; Name of the SubFolder.

Supported API: false

Returns:
String

setSubFolderName

public void setSubFolderName(String a_SubFolderName)
Sets the value of the attribute: subFolderName; Name of the SubFolder.

Supported API: false

Parameters:
a_SubFolderName -

getParentFolderReference

public ObjectReference getParentFolderReference()
Gets the value of the attribute: parentFolderReference; Reference to the parent Folder.

Supported API: false

Returns:
ObjectReference

setParentFolderReference

public void setParentFolderReference(ObjectReference a_ParentFolderReference)
Sets the value of the attribute: parentFolderReference; Reference to the parent Folder.

Supported API: false

Parameters:
a_ParentFolderReference -

setToObject

public void setToObject(Identified obj)
Method to change the the SubFolderLink when uniqueness is changed (eg the SubFolder is move to a new Folder.)

Supported API: false

Specified by:
setToObject in class IdentificationObject
Parameters:
obj -

getIdentity

public String getIdentity()
Returns the internal uniquness value for a SubFolderLink. This is not intended as human readable value, but rather as the interval value for the constraint to be passed to the SubFolderLinkConstraint object.

Supported API: false

Specified by:
getIdentity in class IdentificationObject
Returns:
String

newSubFolderLinkIdentity

protected static SubFolderLinkIdentity newSubFolderLinkIdentity(SubFolderLink link)
                                                         throws WTException
Factory to construct the object. This is a protected method for use by the SubFolderLink itself.

Supported API: false

Parameters:
link -
Returns:
SubFolderLinkIdentity
Throws:
WTException

initialize

protected void initialize(SubFolderLink link)
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:
link -
Throws:
WTException

getKeyClassName

protected String getKeyClassName()
Returns the name of the class (table) that provides the uniqueness constraint for a SubFolderLink. Returns SubFolderLinkConstraint.

Supported API: false

Overrides:
getKeyClassName in class IdentificationObject
Returns:
String
See Also:
SubFolderLinkConstraint