wt.dataops.archivesystem
Class WTArchiveObjectInfo

java.lang.Object
  extended bywt.dataops.archivesystem.WTArchiveObjectInfo
All Implemented Interfaces:
Externalizable, NetFactor, ObjectMappable, Serializable

public final class WTArchiveObjectInfo
extends Object
implements ObjectMappable, Externalizable

Use the newWTArchiveObjectInfo static factory method(s), not the WTArchiveObjectInfo 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
static String ARCHIVE_ID
          Label for the attribute.
private static int ARCHIVE_ID_UPPER_LIMIT
           
static String ARCHIVE_TYPE
          Label for the attribute.
private static int ARCHIVE_TYPE_UPPER_LIMIT
           
private  String archiveId
           
private  WTArchiveType archiveType
           
private static String CLASSNAME
           
static long EXTERNALIZATION_VERSION_UID
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
static String VOLUME_NAME
          Label for the attribute.
private static int VOLUME_NAME_UPPER_LIMIT
           
private  String volumeName
           
 
Constructor Summary
WTArchiveObjectInfo()
           
 
Method Summary
private  void archiveIdValidate(String a_ArchiveId)
           
 String getArchiveId()
          Gets the value of the attribute: ARCHIVE_ID.
 WTArchiveType getArchiveType()
          Gets the value of the attribute: ARCHIVE_TYPE.
 ClassInfo getClassInfo()
          Returns the ClassInfo object for this class.
 String getConceptualClassname()
          Deprecated.  
 String getVolumeName()
          Gets the value of the attribute: VOLUME_NAME.
protected  void initialize(String id, String vol, WTArchiveType aType)
          Supports initialization, following construction of an instance.
static WTArchiveObjectInfo newWTArchiveObjectInfo(String id, String vol, WTArchiveType aType)
          

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(WTArchiveObjectInfo thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
protected  void setArchiveId(String a_ArchiveId)
          Sets the value of the attribute: ARCHIVE_ID.
protected  void setArchiveType(WTArchiveType a_ArchiveType)
          Sets the value of the attribute: ARCHIVE_TYPE.
protected  void setVolumeName(String a_VolumeName)
          Sets the value of the attribute: VOLUME_NAME.
 String toString()
          Returns the conceptual (modeled) name for the class.
private  void volumeNameValidate(String a_VolumeName)
           
 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

ARCHIVE_ID

public static final String ARCHIVE_ID
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

ARCHIVE_ID_UPPER_LIMIT

private static int ARCHIVE_ID_UPPER_LIMIT

archiveId

private String archiveId

VOLUME_NAME

public static final String VOLUME_NAME
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

VOLUME_NAME_UPPER_LIMIT

private static int VOLUME_NAME_UPPER_LIMIT

volumeName

private String volumeName

ARCHIVE_TYPE

public static final String ARCHIVE_TYPE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

ARCHIVE_TYPE_UPPER_LIMIT

private static int ARCHIVE_TYPE_UPPER_LIMIT

archiveType

private WTArchiveType archiveType

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

WTArchiveObjectInfo

public WTArchiveObjectInfo()
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(WTArchiveObjectInfo 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

getArchiveId

public String getArchiveId()
Gets the value of the attribute: ARCHIVE_ID.

Supported API: false

Returns:
String

setArchiveId

protected void setArchiveId(String a_ArchiveId)
                     throws WTPropertyVetoException
Sets the value of the attribute: ARCHIVE_ID.

Supported API: false

Parameters:
a_ArchiveId -
Throws:
WTPropertyVetoException

archiveIdValidate

private void archiveIdValidate(String a_ArchiveId)
                        throws WTPropertyVetoException
Parameters:
a_ArchiveId -
Throws:
WTPropertyVetoException

getVolumeName

public String getVolumeName()
Gets the value of the attribute: VOLUME_NAME.

Supported API: false

Returns:
String

setVolumeName

protected void setVolumeName(String a_VolumeName)
                      throws WTPropertyVetoException
Sets the value of the attribute: VOLUME_NAME.

Supported API: false

Parameters:
a_VolumeName -
Throws:
WTPropertyVetoException

volumeNameValidate

private void volumeNameValidate(String a_VolumeName)
                         throws WTPropertyVetoException
Parameters:
a_VolumeName -
Throws:
WTPropertyVetoException

getArchiveType

public WTArchiveType getArchiveType()
Gets the value of the attribute: ARCHIVE_TYPE.

Supported API: false

Returns:
WTArchiveType

setArchiveType

protected void setArchiveType(WTArchiveType a_ArchiveType)
                       throws WTPropertyVetoException
Sets the value of the attribute: ARCHIVE_TYPE.

Supported API: false

Parameters:
a_ArchiveType -
Throws:
WTPropertyVetoException

newWTArchiveObjectInfo

public static WTArchiveObjectInfo newWTArchiveObjectInfo(String id,
                                                         String vol,
                                                         WTArchiveType aType)
                                                  throws WTException


Supported API: false

Parameters:
id -
vol -
aType -
Returns:
WTArchiveObjectInfo
Throws:
WTException

initialize

protected void initialize(String id,
                          String vol,
                          WTArchiveType aType)
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:
id -
vol -
aType -
Throws:
WTException