wt.dataops.archive
Class Archive

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.dataops.archive.Archive

All Implemented Interfaces:

AccessControlled, ArchiveResident, BusinessInformation, ContentHolder, DisplayIdentification, DomainAdministered, Externalizable, Identified, NetFactor, Notifiable, ObjectMappable, Persistable, RecentlyVisited, Serializable, WTContained, WTContainedIdentified

public class Archive

extends Simple

implements WTContainedIdentified, ContentHolder, ArchiveResident, Externalizable

Use the newArchive static factory method(s), not the Archive 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_SIZE Label for the attribute.
private WTArchiveObjectInfo	archiveObjectInfo
private long	archiveSize
private static String	CLASSNAME
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
private Vector	contentVector
static String	CONTEXT_PATHS Label for the attribute.
private String[]	contextPaths
private WTPrincipalReference	creator
static String	CREATOR Label for the attribute.
private String	description
static String	DESCRIPTION Label for the attribute.
private static int	DESCRIPTION_UPPER_LIMIT
static long	EXTERNALIZATION_VERSION_UID
private boolean	hasContents
private Vector	httpVector
static String	LAST_ACCESSED_STAMP Label for the attribute.
private Timestamp	lastAccessedStamp
private String	name
static String	NAME Label for the attribute.
private static int	NAME_UPPER_LIMIT
static String	NUM_OBJECTS_ARCHIVED Label for the attribute.
private long	numObjectsArchived
protected static long	OLD_FORMAT_VERSION_UID
private HttpContentOperation	operation
private static String	RESOURCE
(package private) static long	serialVersionUID
private String	version
static String	VERSION Label for the attribute.
private static int	VERSION_UPPER_LIMIT
private static String	WINDCHILL_SERVICE
private static String	WINDCHILL_VERSION

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.inf.container.WTContainedIdentified

CONTAINER_REFERENCE

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.content.ContentHolder

CONTENT_VECTOR, HAS_CONTENTS, HTTP_VECTOR, OPERATION

Fields inherited from interface wt.dataops.archivesystem.ArchiveResident

ARCHIVE_OBJECT_INFO

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

Archive()

Method Summary

private void	archiveObjectInfoValidate(WTArchiveObjectInfo a_ArchiveObjectInfo)
private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
private void	creatorValidate(WTPrincipalReference a_Creator)
private void	descriptionValidate(String a_Description)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
WTArchiveObjectInfo	getArchiveObjectInfo() Gets the object for the association that plays role: ARCHIVE_OBJECT_INFO.
long	getArchiveSize() Gets the value of the attribute: ARCHIVE_SIZE.
String	getConceptualClassname() Deprecated.
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
Vector	getContentVector() Gets the value of the attribute: CONTENT_VECTOR.
String[]	getContextPaths() Gets the value of the attribute: CONTEXT_PATHS.
WTPrincipalReference	getCreator() Gets the object for the association that plays role: CREATOR.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
Vector	getHttpVector() Gets the value of the attribute: HTTP_VECTOR.
IdentificationObject	getIdentificationObject() Constructs and returns an identification object.
Timestamp	getLastAccessedStamp() Gets the value of the attribute: LAST_ACCESSED_STAMP.
String	getName() Gets the value of the attribute: NAME.
long	getNumObjectsArchived() Gets the value of the attribute: NUM_OBJECTS_ARCHIVED.
HttpContentOperation	getOperation() Gets the value of the attribute: OPERATION.
private static String	getWindchillVersion()
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(ArchiveRecord record) Supports initialization, following construction of an instance.
boolean	isHasContents() Gets the value of the attribute: HAS_CONTENTS.
private void	nameValidate(String a_Name)
static Archive	newArchive(ArchiveRecord record) 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(Archive thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setArchiveObjectInfo(WTArchiveObjectInfo a_ArchiveObjectInfo) Sets the object for the association that plays role: ARCHIVE_OBJECT_INFO.
void	setArchiveSize(long a_ArchiveSize) Sets the value of the attribute: ARCHIVE_SIZE.
void	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
void	setContentVector(Vector a_ContentVector) Sets the value of the attribute: CONTENT_VECTOR.
void	setContextPaths(String[] a_ContextPaths) Sets the value of the attribute: CONTEXT_PATHS.
void	setCreator(WTPrincipalReference a_Creator) Sets the object for the association that plays role: CREATOR.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setHasContents(boolean a_HasContents) Sets the value of the attribute: HAS_CONTENTS.
void	setHttpVector(Vector a_HttpVector) Sets the value of the attribute: HTTP_VECTOR.
void	setLastAccessedStamp(Timestamp a_LastAccessedStamp) Sets the value of the attribute: LAST_ACCESSED_STAMP.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setNumObjectsArchived(long a_NumObjectsArchived) Sets the value of the attribute: NUM_OBJECTS_ARCHIVED.
void	setOperation(HttpContentOperation a_Operation) Sets the value of the attribute: OPERATION.
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.enterprise.Simple

getBusinessType, getDomainRef, getEventSet, getIdentity, initialize, isInheritedDomain, readVersion, setDomainRef, setEventSet, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

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

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

CONTEXT_PATHS

public static final String CONTEXT_PATHS

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

contextPaths

private String[] contextPaths

LAST_ACCESSED_STAMP

public static final String LAST_ACCESSED_STAMP

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

lastAccessedStamp

private Timestamp lastAccessedStamp

NUM_OBJECTS_ARCHIVED

public static final String NUM_OBJECTS_ARCHIVED

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

numObjectsArchived

private long numObjectsArchived

ARCHIVE_SIZE

public static final String ARCHIVE_SIZE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

archiveSize

private long archiveSize

VERSION

public static final String VERSION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

VERSION_UPPER_LIMIT

private static int VERSION_UPPER_LIMIT

version

private String version

CREATOR

public static final String CREATOR

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

creator

private WTPrincipalReference creator

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

contentVector

private Vector contentVector

hasContents

private boolean hasContents

operation

private HttpContentOperation operation

httpVector

private Vector httpVector

archiveObjectInfo

private WTArchiveObjectInfo archiveObjectInfo

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

WINDCHILL_SERVICE

private static final String WINDCHILL_SERVICE

See Also:

Constant Field Values

WINDCHILL_VERSION

private static String WINDCHILL_VERSION

Constructor Detail

Archive

public Archive()

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 Simple

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 Simple

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 Simple

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

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: false

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION.

Supported API: false

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getContextPaths

public String[] getContextPaths()

Gets the value of the attribute: CONTEXT_PATHS.

Supported API: false

Returns:

String[]

setContextPaths

public void setContextPaths(String[] a_ContextPaths)
                     throws WTPropertyVetoException

Sets the value of the attribute: CONTEXT_PATHS.

Supported API: false

Parameters:

a_ContextPaths -

Throws:

WTPropertyVetoException

getLastAccessedStamp

public Timestamp getLastAccessedStamp()

Gets the value of the attribute: LAST_ACCESSED_STAMP.

Supported API: false

Returns:

Timestamp

setLastAccessedStamp

public void setLastAccessedStamp(Timestamp a_LastAccessedStamp)
                          throws WTPropertyVetoException

Sets the value of the attribute: LAST_ACCESSED_STAMP.

Supported API: false

Parameters:

a_LastAccessedStamp -

Throws:

WTPropertyVetoException

getNumObjectsArchived

public long getNumObjectsArchived()

Gets the value of the attribute: NUM_OBJECTS_ARCHIVED.

Supported API: false

Returns:

long

setNumObjectsArchived

public void setNumObjectsArchived(long a_NumObjectsArchived)
                           throws WTPropertyVetoException

Sets the value of the attribute: NUM_OBJECTS_ARCHIVED.

Supported API: false

Parameters:

a_NumObjectsArchived -

Throws:

WTPropertyVetoException

getArchiveSize

public long getArchiveSize()

Gets the value of the attribute: ARCHIVE_SIZE.

Supported API: false

Returns:

long

setArchiveSize

public void setArchiveSize(long a_ArchiveSize)
                    throws WTPropertyVetoException

Sets the value of the attribute: ARCHIVE_SIZE.

Supported API: false

Parameters:

a_ArchiveSize -

Throws:

WTPropertyVetoException

getCreator

public WTPrincipalReference getCreator()

Gets the object for the association that plays role: CREATOR.

Supported API: false

Returns:

WTPrincipalReference

setCreator

public void setCreator(WTPrincipalReference a_Creator)
                throws WTPropertyVetoException

Sets the object for the association that plays role: CREATOR.

Supported API: false

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

creatorValidate

private void creatorValidate(WTPrincipalReference a_Creator)
                      throws WTPropertyVetoException

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

newArchive

public static Archive newArchive(ArchiveRecord record)
                          throws WTException

Supported API: false

Parameters:

record -

Returns:

Archive

Throws:

WTException

initialize

protected void initialize(ArchiveRecord record)
                   throws WTException

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

Supported API: false

Parameters:

record -

Throws:

WTException

getContainer

public WTContainer getContainer()

Gets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:

getContainer in interface WTContainedIdentified

Returns:

WTContainer

setContainer

public void setContainer(WTContainer a_Container)
                  throws WTPropertyVetoException,
                         WTException

Sets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:

setContainer in interface WTContainedIdentified

Parameters:

a_Container -

Throws:

WTPropertyVetoException

WTException

getContainerReference

public WTContainerRef getContainerReference()

Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

getContainerReference in interface WTContainedIdentified

Returns:

WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

setContainerReference in interface WTContainedIdentified

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

getContainerName

public String getContainerName()

Gets the value of the attribute: CONTAINER_NAME. The name of the WTContainer this object is assigned to.

Supported API: false

Specified by:

getContainerName in interface WTContained

Returns:

String

getIdentificationObject

public IdentificationObject getIdentificationObject()
                                             throws WTException

Constructs and returns an identification object. This method is the only way to obtain an identification object.

Supported API: false

Specified by:

getIdentificationObject in interface Identified

Returns:

IdentificationObject

Throws:

WTException

getContentVector

public Vector getContentVector()

Gets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getContentVector in interface ContentHolder

Returns:

Vector

setContentVector

public void setContentVector(Vector a_ContentVector)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setContentVector in interface ContentHolder

Parameters:

a_ContentVector -

Throws:

WTPropertyVetoException

isHasContents

public boolean isHasContents()

Gets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

isHasContents in interface ContentHolder

Returns:

boolean

setHasContents

public void setHasContents(boolean a_HasContents)
                    throws WTPropertyVetoException

Sets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

setHasContents in interface ContentHolder

Parameters:

a_HasContents -

Throws:

WTPropertyVetoException

getOperation

public HttpContentOperation getOperation()

Gets the value of the attribute: OPERATION.

Supported API: false

Specified by:

getOperation in interface ContentHolder

Returns:

HttpContentOperation

setOperation

public void setOperation(HttpContentOperation a_Operation)
                  throws WTPropertyVetoException

Sets the value of the attribute: OPERATION.

Supported API: false

Specified by:

setOperation in interface ContentHolder

Parameters:

a_Operation -

Throws:

WTPropertyVetoException

getHttpVector

public Vector getHttpVector()

Gets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getHttpVector in interface ContentHolder

Returns:

Vector

setHttpVector

public void setHttpVector(Vector a_HttpVector)
                   throws WTPropertyVetoException

Sets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setHttpVector in interface ContentHolder

Parameters:

a_HttpVector -

Throws:

WTPropertyVetoException

getArchiveObjectInfo

public WTArchiveObjectInfo getArchiveObjectInfo()

Gets the object for the association that plays role: ARCHIVE_OBJECT_INFO.

Supported API: false

Specified by:

getArchiveObjectInfo in interface ArchiveResident

Returns:

WTArchiveObjectInfo

setArchiveObjectInfo

public void setArchiveObjectInfo(WTArchiveObjectInfo a_ArchiveObjectInfo)
                          throws WTPropertyVetoException

Sets the object for the association that plays role: ARCHIVE_OBJECT_INFO.

Supported API: false

Specified by:

setArchiveObjectInfo in interface ArchiveResident

Parameters:

a_ArchiveObjectInfo -

Throws:

WTPropertyVetoException

archiveObjectInfoValidate

private void archiveObjectInfoValidate(WTArchiveObjectInfo a_ArchiveObjectInfo)
                                throws WTPropertyVetoException

Parameters:

a_ArchiveObjectInfo -

Throws:

WTPropertyVetoException

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 Simple

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 Simple

Returns:

int

getWindchillVersion

private static String getWindchillVersion()
                                   throws WTException

Throws:

WTException