wt.dataops
Class DataMaintRecord

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.dataops.DataMaintRecord

All Implemented Interfaces:

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

Direct Known Subclasses:

ArchiveRecord, PurgeRecord, RestoreRecord

public abstract class DataMaintRecord

extends Simple

implements ContentHolder, WTContainedIdentified, CollectionOp, Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

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.
static String	CRITERIA Label for the attribute.
private ObjectReference	criteriaReference
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	MAP Label for the attribute.
private ObjectReference	mapReference
private String	name
static String	NAME Label for the attribute.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private HttpContentOperation	operation
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	STATUS Label for the attribute.

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.content.ContentHolder

CONTENT_VECTOR, HAS_CONTENTS, HTTP_VECTOR, OPERATION

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

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.dataops.objectcol.CollectionOp

CRITERIA_REFERENCE, MAP_REFERENCE

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

DataMaintRecord()

Method Summary

private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
private void	creatorValidate(WTPrincipalReference a_Creator)
private void	criteriaReferenceValidate(ObjectReference a_CriteriaReference)
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.
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.
private ContentItem	getContentWithPrefix(String prefix)
String[]	getContextPaths() Gets the value of the attribute: CONTEXT_PATHS.
WTPrincipalReference	getCreator() Gets the object for the association that plays role: CREATOR.
CollectionCriteria	getCriteria() Gets the object for the association that plays role: CRITERIA.
ObjectReference	getCriteriaReference() Gets the value of the attribute: CRITERIA_REFERENCE.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
Vector	getHttpVector() Gets the value of the attribute: HTTP_VECTOR.
ContentItem	getLog() Gets the log of this data operation.
abstract String	getLogNamePrefix() Supported API: false
RelationshipMap	getMap() Gets the object for the association that plays role: MAP.
ObjectReference	getMapReference() Gets the value of the attribute: MAP_REFERENCE.
String	getName() Gets the value of the attribute: NAME.
ContentItem	getOperandsInfo() Gets the operands of this data operation.
abstract String	getOperandsInfoPrefix() Supported API: false
HttpContentOperation	getOperation() Gets the value of the attribute: OPERATION.
abstract EnumeratedType	getStatus() Gets the object for the association that plays role: STATUS.
abstract TaskEvent	getTaskEvent()
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
boolean	isHasContents() Gets the value of the attribute: HAS_CONTENTS.
private void	mapReferenceValidate(ObjectReference a_MapReference)
private void	nameValidate(String a_Name)
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(DataMaintRecord thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
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.
protected 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	setCriteria(CollectionCriteria a_Criteria) Sets the object for the association that plays role: CRITERIA.
void	setCriteriaReference(ObjectReference a_CriteriaReference) Sets the value of the attribute: CRITERIA_REFERENCE.
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	setMap(RelationshipMap a_Map) Sets the object for the association that plays role: MAP.
void	setMapReference(ObjectReference a_MapReference) Sets the value of the attribute: MAP_REFERENCE.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setOperation(HttpContentOperation a_Operation) Sets the value of the attribute: OPERATION.
protected abstract void	setStatus(EnumeratedType a_Status) Sets the object for the association that plays role: STATUS.
abstract void	setTaskEvent(TaskEvent a_TaskEvent)
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, getConceptualClassname

Methods inherited from interface wt.fc.Identified

getIdentificationObject

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

CREATOR

public static final String CREATOR

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

creator

private WTPrincipalReference creator

STATUS

public static final String STATUS

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

contentVector

private Vector contentVector

hasContents

private boolean hasContents

operation

private HttpContentOperation operation

httpVector

private Vector httpVector

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

CRITERIA

public static final String CRITERIA

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

criteriaReference

private ObjectReference criteriaReference

MAP

public static final String MAP

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

mapReference

private ObjectReference mapReference

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

DataMaintRecord

public DataMaintRecord()

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(DataMaintRecord 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

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

protected void setContextPaths(String[] a_ContextPaths)
                        throws WTPropertyVetoException

Sets the value of the attribute: CONTEXT_PATHS.

Supported API: false

Parameters:

a_ContextPaths -

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

getStatus

public abstract EnumeratedType getStatus()

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

Supported API: false

Returns:

EnumeratedType

setStatus

protected abstract void setStatus(EnumeratedType a_Status)
                           throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_Status -

Throws:

WTPropertyVetoException

getLog

public ContentItem getLog()
                   throws WTException

Gets the log of this data operation. This should be done after a call to ContentHelper.service.getContents( DataMaintRecord )

Supported API: false

Returns:

ContentItem

Throws:

WTException

getOperandsInfo

public ContentItem getOperandsInfo()
                            throws WTException

Gets the operands of this data operation. This should be done after a call to ContentHelper.service.getContents( DataMaintRecord )

Supported API: false

Returns:

ContentItem

Throws:

WTException

getLogNamePrefix

public abstract String getLogNamePrefix()

Supported API: false

Returns:

String

getOperandsInfoPrefix

public abstract String getOperandsInfoPrefix()

Supported API: false

Returns:

String

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

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

getCriteria

public CollectionCriteria getCriteria()

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

Supported API: false

Specified by:

getCriteria in interface CollectionOp

Returns:

CollectionCriteria

setCriteria

public void setCriteria(CollectionCriteria a_Criteria)
                 throws WTPropertyVetoException,
                        WTException

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

Supported API: false

Specified by:

setCriteria in interface CollectionOp

Parameters:

a_Criteria -

Throws:

WTPropertyVetoException

WTException

getCriteriaReference

public ObjectReference getCriteriaReference()

Gets the value of the attribute: CRITERIA_REFERENCE.

Supported API: false

Specified by:

getCriteriaReference in interface CollectionOp

Returns:

ObjectReference

setCriteriaReference

public void setCriteriaReference(ObjectReference a_CriteriaReference)
                          throws WTPropertyVetoException

Sets the value of the attribute: CRITERIA_REFERENCE.

Supported API: false

Specified by:

setCriteriaReference in interface CollectionOp

Parameters:

a_CriteriaReference -

Throws:

WTPropertyVetoException

criteriaReferenceValidate

private void criteriaReferenceValidate(ObjectReference a_CriteriaReference)
                                throws WTPropertyVetoException

Parameters:

a_CriteriaReference -

Throws:

WTPropertyVetoException

getMap

public RelationshipMap getMap()

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

Supported API: false

Specified by:

getMap in interface CollectionOp

Returns:

RelationshipMap

setMap

public void setMap(RelationshipMap a_Map)
            throws WTPropertyVetoException,
                   WTException

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

Supported API: false

Specified by:

setMap in interface CollectionOp

Parameters:

a_Map -

Throws:

WTPropertyVetoException

WTException

getMapReference

public ObjectReference getMapReference()

Gets the value of the attribute: MAP_REFERENCE.

Supported API: false

Specified by:

getMapReference in interface CollectionOp

Returns:

ObjectReference

setMapReference

public void setMapReference(ObjectReference a_MapReference)
                     throws WTPropertyVetoException

Sets the value of the attribute: MAP_REFERENCE.

Supported API: false

Specified by:

setMapReference in interface CollectionOp

Parameters:

a_MapReference -

Throws:

WTPropertyVetoException

mapReferenceValidate

private void mapReferenceValidate(ObjectReference a_MapReference)
                           throws WTPropertyVetoException

Parameters:

a_MapReference -

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

getContentWithPrefix

private ContentItem getContentWithPrefix(String prefix)
                                  throws WTException

Throws:

WTException

getTaskEvent

public abstract TaskEvent getTaskEvent()

setTaskEvent

public abstract void setTaskEvent(TaskEvent a_TaskEvent)
                           throws WTPropertyVetoException,
                                  WTException

Throws:

WTPropertyVetoException

WTException