wt.fc
Class PersistInfo

java.lang.Object
  extended bywt.fc.PersistInfo
All Implemented Interfaces:
Externalizable, NetFactor, ObjectMappable, Serializable

public final class PersistInfo
extends Object
implements ObjectMappable, Externalizable

PersistInfo represents the information that must be maintained about a Persistable object.

Use the newPersistInfo static factory method(s), not the PersistInfo 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
private static String CLASSNAME
           
static String CREATE_STAMP
          Label for the attribute.
private  Timestamp createStamp
           
static long EXTERNALIZATION_VERSION_UID
           
private  boolean isDeleted
           
private  boolean isPersisted
           
static String MARK_FOR_DELETE
          Label for the attribute; Indicates object as marked for delete if > 0.
private  long markForDelete
           
static String MODIFY_STAMP
          Label for the attribute.
private  Timestamp modifyStamp
           
static String OBJECT_IDENTIFIER
          Label for the attribute.
protected static long OLD_FORMAT_VERSION_UID
           
static boolean persistIfcRead
           
static boolean persistIfcWrite
           
static boolean persistRmiRead
           
static boolean persistRmiWrite
           
private static long R4_THRU_R62X_VESION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
private  ObjectIdentifier theObjectIdentifier
           
static String UPDATE_COUNT
          Label for the attribute.
static String UPDATE_STAMP
          Label for the attribute.
private  int updateCount
           
private  Timestamp updateStamp
           
 
Constructor Summary
PersistInfo()
           
PersistInfo(ObjectIdentifier oid)
           
 
Method Summary
 ClassInfo getClassInfo()
          Returns the ClassInfo object for this class.
 String getConceptualClassname()
          Deprecated.  
 Timestamp getCreateStamp()
          Gets the value of the attribute: CREATE_STAMP.
 long getMarkForDelete()
          Gets the value of the attribute: MARK_FOR_DELETE.
 Timestamp getModifyStamp()
          Gets the value of the attribute: MODIFY_STAMP.
 ObjectIdentifier getObjectIdentifier()
          Gets the object for the association that plays role: OBJECT_IDENTIFIER.
 int getUpdateCount()
          Gets the value of the attribute: UPDATE_COUNT.
 Timestamp getUpdateStamp()
          Gets the value of the attribute: UPDATE_STAMP.
protected  void initialize()
          

Supported API: false
protected  void initialize(ObjectIdentifier oid)
          

Supported API: false
 boolean isDeleted()
          

Supported API: false
 boolean isPersisted()
          

Supported API: false
 void makeDeleted()
          

Supported API: false
 void makeNonPersistent()
          Sets the isPersisted flag to false, and resets the update count.
 void makePersisted()
          

Supported API: false
static PersistInfo newPersistInfo()
          

Supported API: false
static PersistInfo newPersistInfo(ObjectIdentifier oid)
          

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(PersistInfo thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void refresh(PersistentRetrieveIfc aPRI, String container)
          

Supported API: false
private  void repPersistIfcReadInfo()
           
private  void repPersistIfcWriteInfo()
           
private  void repPersistRmiReadInfo()
           
private  void repPersistRmiWriteInfo()
           
(package private)  void resetDeleted()
           
 void setCreateStamp(Timestamp a_CreateStamp)
          Sets the value of the attribute: CREATE_STAMP.
 void setMarkForDelete(long a_MarkForDelete)
          Sets the value of the attribute: MARK_FOR_DELETE.
 void setModifyStamp(Timestamp a_ModifyStamp)
          Sets the value of the attribute: MODIFY_STAMP.
protected  void setObjectIdentifier(ObjectIdentifier a_ObjectIdentifier)
          Sets the object for the association that plays role: OBJECT_IDENTIFIER.
 void setUpdateCount(int a_UpdateCount)
          Sets the value of the attribute: UPDATE_COUNT.
 void setUpdateStamp(Timestamp a_UpdateStamp)
          Sets the value of the attribute: UPDATE_STAMP.
 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, 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

CREATE_STAMP

public static final String CREATE_STAMP
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

createStamp

private Timestamp createStamp

MODIFY_STAMP

public static final String MODIFY_STAMP
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

modifyStamp

private Timestamp modifyStamp

UPDATE_STAMP

public static final String UPDATE_STAMP
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

updateStamp

private Timestamp updateStamp

UPDATE_COUNT

public static final String UPDATE_COUNT
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

updateCount

private int updateCount

MARK_FOR_DELETE

public static final String MARK_FOR_DELETE
Label for the attribute; Indicates object as marked for delete if > 0.

Supported API: false

See Also:
Constant Field Values

markForDelete

private long markForDelete

isDeleted

private boolean isDeleted

isPersisted

private boolean isPersisted

OBJECT_IDENTIFIER

public static final String OBJECT_IDENTIFIER
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

theObjectIdentifier

private ObjectIdentifier theObjectIdentifier

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

R4_THRU_R62X_VESION_UID

private static final long R4_THRU_R62X_VESION_UID
See Also:
Constant Field Values

persistRmiWrite

public static boolean persistRmiWrite

persistRmiRead

public static boolean persistRmiRead

persistIfcWrite

public static boolean persistIfcWrite

persistIfcRead

public static boolean persistIfcRead
Constructor Detail

PersistInfo

public PersistInfo()

PersistInfo

public PersistInfo(ObjectIdentifier oid)
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(PersistInfo 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

getCreateStamp

public Timestamp getCreateStamp()
Gets the value of the attribute: CREATE_STAMP.

Supported API: false

Returns:
Timestamp

setCreateStamp

public void setCreateStamp(Timestamp a_CreateStamp)
Sets the value of the attribute: CREATE_STAMP.

Supported API: false

Parameters:
a_CreateStamp -

getModifyStamp

public Timestamp getModifyStamp()
Gets the value of the attribute: MODIFY_STAMP.

Supported API: false

Returns:
Timestamp

setModifyStamp

public void setModifyStamp(Timestamp a_ModifyStamp)
Sets the value of the attribute: MODIFY_STAMP.

Supported API: false

Parameters:
a_ModifyStamp -

getUpdateStamp

public Timestamp getUpdateStamp()
Gets the value of the attribute: UPDATE_STAMP.

Supported API: false

Returns:
Timestamp

setUpdateStamp

public void setUpdateStamp(Timestamp a_UpdateStamp)
Sets the value of the attribute: UPDATE_STAMP.

Supported API: false

Parameters:
a_UpdateStamp -

getUpdateCount

public int getUpdateCount()
Gets the value of the attribute: UPDATE_COUNT.

Supported API: false

Returns:
int

setUpdateCount

public void setUpdateCount(int a_UpdateCount)
Sets the value of the attribute: UPDATE_COUNT.

Supported API: false

Parameters:
a_UpdateCount -

getMarkForDelete

public long getMarkForDelete()
Gets the value of the attribute: MARK_FOR_DELETE. Indicates object as marked for delete if > 0.

Supported API: false

Returns:
long

setMarkForDelete

public void setMarkForDelete(long a_MarkForDelete)
Sets the value of the attribute: MARK_FOR_DELETE. Indicates object as marked for delete if > 0.

Supported API: false

Parameters:
a_MarkForDelete -

getObjectIdentifier

public ObjectIdentifier getObjectIdentifier()
Gets the object for the association that plays role: OBJECT_IDENTIFIER.

Supported API: false

Returns:
ObjectIdentifier

setObjectIdentifier

protected void setObjectIdentifier(ObjectIdentifier a_ObjectIdentifier)
Sets the object for the association that plays role: OBJECT_IDENTIFIER.

Supported API: false

Parameters:
a_ObjectIdentifier -

newPersistInfo

public static PersistInfo newPersistInfo()
                                  throws WTException


Supported API: false

Returns:
PersistInfo
Throws:
WTException

newPersistInfo

public static PersistInfo newPersistInfo(ObjectIdentifier oid)
                                  throws WTException


Supported API: false

Parameters:
oid -
Returns:
PersistInfo
Throws:
WTException

refresh

public void refresh(PersistentRetrieveIfc aPRI,
                    String container)
             throws SQLException


Supported API: false

Parameters:
aPRI -
container -
Throws:
SQLException

makeDeleted

public void makeDeleted()


Supported API: false


isDeleted

public boolean isDeleted()


Supported API: false

Returns:
boolean

initialize

protected void initialize()


Supported API: false


initialize

protected void initialize(ObjectIdentifier oid)


Supported API: false

Parameters:
oid -

makePersisted

public void makePersisted()


Supported API: false


makeNonPersistent

public void makeNonPersistent()
Sets the isPersisted flag to false, and resets the update count.

Supported API: false


isPersisted

public boolean isPersisted()


Supported API: false

Returns:
boolean

resetDeleted

void resetDeleted()

repPersistRmiReadInfo

private void repPersistRmiReadInfo()

repPersistRmiWriteInfo

private void repPersistRmiWriteInfo()

repPersistIfcReadInfo

private void repPersistIfcReadInfo()

repPersistIfcWriteInfo

private void repPersistIfcWriteInfo()