wt.fv
Class StoredItem

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.fv.StoredItem
All Implemented Interfaces:
DisplayIdentification, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable
Direct Known Subclasses:
FvItem, MasteredOnReplicaItem, ReplicatedItem

public abstract class StoredItem
extends WTObject
implements Externalizable



Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
static long EXTERNALIZATION_VERSION_UID
           
static String FOLDER
          Label for the attribute.
static String FOLDER_REFERENCE
          Label for the attribute.
private  ObjectReference folderReference
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
private static String STRING_OF_ZEROES
           
static String UNIQUE_SEQUENCE_NUMBER
          Label for the attribute.
private  long uniqueSequenceNumber
           
 
Fields inherited from class wt.fc.WTObject
CREATE_TIMESTAMP, MODIFY_TIMESTAMP
 
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
StoredItem()
           
 
Method Summary
static String buildFileName(long a_Number)
           
 boolean equals(Object obj)
          Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
private  void folderReferenceValidate(ObjectReference a_FolderReference)
           
 FileFolder getFolder()
          Gets the object for the association that plays role: FOLDER.
 ObjectReference getFolderReference()
          Gets the value of the attribute: FOLDER_REFERENCE.
 String getName()
          

Supported API: false
 long getUniqueSequenceNumber()
          Gets the value of the attribute: UNIQUE_SEQUENCE_NUMBER.
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
 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(StoredItem thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setFolder(FileFolder a_Folder)
          Sets the object for the association that plays role: FOLDER.
 void setFolderReference(ObjectReference a_FolderReference)
          Sets the value of the attribute: FOLDER_REFERENCE.
 void setUniqueSequenceNumber(long a_UniqueSequenceNumber)
          Sets the value of the attribute: UNIQUE_SEQUENCE_NUMBER.
 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.WTObject
checkAttributes, duplicate, 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.NetFactor
getConceptualClassname
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

UNIQUE_SEQUENCE_NUMBER

public static final String UNIQUE_SEQUENCE_NUMBER
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

uniqueSequenceNumber

private long uniqueSequenceNumber

FOLDER

public static final String FOLDER
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

FOLDER_REFERENCE

public static final String FOLDER_REFERENCE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

folderReference

private ObjectReference folderReference

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

STRING_OF_ZEROES

private static final String STRING_OF_ZEROES
See Also:
Constant Field Values
Constructor Detail

StoredItem

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

readVersion

protected boolean readVersion(StoredItem 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 WTObject
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 WTObject
Parameters:
input -
Throws:
SQLException
DatastoreException

getUniqueSequenceNumber

public long getUniqueSequenceNumber()
Gets the value of the attribute: UNIQUE_SEQUENCE_NUMBER.

Supported API: false

Returns:
long

setUniqueSequenceNumber

public void setUniqueSequenceNumber(long a_UniqueSequenceNumber)
                             throws WTPropertyVetoException
Sets the value of the attribute: UNIQUE_SEQUENCE_NUMBER.

Supported API: false

Parameters:
a_UniqueSequenceNumber -
Throws:
WTPropertyVetoException

getFolder

public FileFolder getFolder()
Gets the object for the association that plays role: FOLDER.

Supported API: false

Returns:
FileFolder

setFolder

public void setFolder(FileFolder a_Folder)
               throws WTPropertyVetoException,
                      WTException
Sets the object for the association that plays role: FOLDER.

Supported API: false

Parameters:
a_Folder -
Throws:
WTPropertyVetoException
WTException

getFolderReference

public ObjectReference getFolderReference()
Gets the value of the attribute: FOLDER_REFERENCE.

Supported API: false

Returns:
ObjectReference

setFolderReference

public void setFolderReference(ObjectReference a_FolderReference)
                        throws WTPropertyVetoException
Sets the value of the attribute: FOLDER_REFERENCE.

Supported API: false

Parameters:
a_FolderReference -
Throws:
WTPropertyVetoException

folderReferenceValidate

private void folderReferenceValidate(ObjectReference a_FolderReference)
                              throws WTPropertyVetoException
Parameters:
a_FolderReference -
Throws:
WTPropertyVetoException

getName

public String getName()


Supported API: false

Returns:
String

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 WTObject
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 WTObject
Returns:
int

buildFileName

public static String buildFileName(long a_Number)