wt.viewmarkup
Class WTMarkUp

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.viewmarkup.WTMarkUp

All Implemented Interfaces:

AccessControlled, ContentHolder, DisplayIdentification, DomainAdministered, Externalizable, FormatContentHolder, Lockable, MarkUp, NetFactor, ObjectMappable, Ownable, Persistable, Serializable

public class WTMarkUp

extends Item

implements MarkUp, Ownable, Externalizable

Use the newWTMarkUp static factory method(s), not the WTMarkUp 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 int	ADDITIONAL_INFO_UPPER_LIMIT
private String	additionalInfo
static String	ALLOW_COPY_FORWARD Label for the attribute; Should the markup be copied forward to the next iteration of the Viewable? Supported API: false
private boolean	allowCopyForward
private static String	CLASSNAME
private Vector	contentVector
private String	description
private static int	DESCRIPTION_UPPER_LIMIT
static long	EXTERNALIZATION_VERSION_UID
private DataFormatReference	format
private boolean	hasContents
private Vector	httpVector
private Lock	lock
private static int	MARK_UP_TYPE_UPPER_LIMIT
private MarkUpType	MarkUpType
private String	name
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private HttpContentOperation	operation
private Ownership	ownership
private ContentItem	primary
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.Item

VERSION_40_UID, VERSION_51_UID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.viewmarkup.MarkUp

ADDITIONAL_INFO, DESCRIPTION, MARK_UP_TYPE, NAME

Fields inherited from interface wt.content.FormatContentHolder

FORMAT, FORMAT_NAME, PRIMARY

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.locks.Lockable

LOCK, LOCK_DATE, LOCK_NOTE, LOCKED, LOCKER, LOCKER_EMAIL, LOCKER_FULL_NAME, LOCKER_NAME

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

WTMarkUp()

Method Summary

private void	additionalInfoValidate(String a_AdditionalInfo)
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.
private void	formatValidate(DataFormatReference a_Format)
String	getAdditionalInfo() Gets the value of the attribute: ADDITIONAL_INFO.
String	getConceptualClassname() Deprecated.
Vector	getContentVector() Gets the value of the attribute: CONTENT_VECTOR.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
DataFormatReference	getFormat() Gets the object for the association that plays role: FORMAT.
String	getFormatName() Gets the value of the attribute: FORMAT_NAME.
Vector	getHttpVector() Gets the value of the attribute: HTTP_VECTOR.
String	getIdentity() Supported API: false
Lock	getLock() Gets the object for the association that plays role: LOCK.
Timestamp	getLockDate() Gets the value of the attribute: LOCK_DATE.
WTPrincipalReference	getLocker() Gets the value of the attribute: LOCKER.
String	getLockerEMail() Gets the value of the attribute: LOCKER_EMAIL.
String	getLockerFullName() Gets the value of the attribute: LOCKER_FULL_NAME.
String	getLockerName() Gets the value of the attribute: LOCKER_NAME.
String	getLockNote() Gets the value of the attribute: LOCK_NOTE.
MarkUpType	getMarkUpType() Gets the object for the association that plays role: MARK_UP_TYPE.
String	getName() Gets the value of the attribute: NAME.
HttpContentOperation	getOperation() Gets the value of the attribute: OPERATION.
Ownership	getOwnership() Gets the object for the association that plays role: OWNERSHIP.
ContentItem	getPrimary() Gets the value of the attribute: PRIMARY.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String newName) Supports initialization, following construction of an instance.
boolean	isAllowCopyForward() Gets the value of the attribute: ALLOW_COPY_FORWARD.
boolean	isHasContents() Gets the value of the attribute: HAS_CONTENTS.
boolean	isLocked() Gets the value of the attribute: LOCKED.
private void	lockValidate(Lock a_Lock)
private void	MarkUpTypeValidate(MarkUpType a_MarkUpType)
private void	nameValidate(String a_Name)
static WTMarkUp	newWTMarkUp(String newName) 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(WTMarkUp thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAdditionalInfo(String a_AdditionalInfo) Sets the value of the attribute: ADDITIONAL_INFO.
void	setAllowCopyForward(boolean a_AllowCopyForward) Sets the value of the attribute: ALLOW_COPY_FORWARD.
void	setContentVector(Vector a_ContentVector) Sets the value of the attribute: CONTENT_VECTOR.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setFormat(DataFormatReference a_Format) Sets the object for the association that plays role: FORMAT.
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	setLock(Lock a_Lock) Sets the object for the association that plays role: LOCK.
void	setMarkUpType(MarkUpType a_MarkUpType) Sets the object for the association that plays role: MARK_UP_TYPE.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setOperation(HttpContentOperation a_Operation) Sets the value of the attribute: OPERATION.
void	setOwnership(Ownership a_Ownership) Sets the object for the association that plays role: OWNERSHIP.
void	setPrimary(ContentItem a_Primary) Sets the value of the attribute: PRIMARY.
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.Item

getDomainRef, initialize, isInheritedDomain, readVersion, setDomainRef, 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, 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

ALLOW_COPY_FORWARD

public static final String ALLOW_COPY_FORWARD

Label for the attribute; Should the markup be copied forward to the next iteration of the Viewable?

Supported API: false

See Also:

Constant Field Values

allowCopyForward

private boolean allowCopyForward

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

ADDITIONAL_INFO_UPPER_LIMIT

private static int ADDITIONAL_INFO_UPPER_LIMIT

additionalInfo

private String additionalInfo

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

MARK_UP_TYPE_UPPER_LIMIT

private static int MARK_UP_TYPE_UPPER_LIMIT

MarkUpType

private MarkUpType MarkUpType

primary

private ContentItem primary

format

private DataFormatReference format

contentVector

private Vector contentVector

hasContents

private boolean hasContents

operation

private HttpContentOperation operation

httpVector

private Vector httpVector

lock

private Lock lock

ownership

private Ownership ownership

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

WTMarkUp

public WTMarkUp()

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 Item

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 Item

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WTMarkUp 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 Item

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 Item

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

isAllowCopyForward

public boolean isAllowCopyForward()

Gets the value of the attribute: ALLOW_COPY_FORWARD. Should the markup be copied forward to the next iteration of the Viewable?

Supported API: false

Returns:

boolean

setAllowCopyForward

public void setAllowCopyForward(boolean a_AllowCopyForward)
                         throws WTPropertyVetoException

Sets the value of the attribute: ALLOW_COPY_FORWARD. Should the markup be copied forward to the next iteration of the Viewable?

Supported API: false

Parameters:

a_AllowCopyForward -

Throws:

WTPropertyVetoException

newWTMarkUp

public static WTMarkUp newWTMarkUp(String newName)
                            throws WTPropertyVetoException

Supported API: false

Parameters:

newName -

Returns:

WTMarkUp

Throws:

WTPropertyVetoException

initialize

protected void initialize(String newName)
                   throws WTPropertyVetoException

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

Supported API: false

Parameters:

newName -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: false

Specified by:

getDescription in interface MarkUp

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION.

Supported API: false

Specified by:

setDescription in interface MarkUp

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getAdditionalInfo

public String getAdditionalInfo()

Gets the value of the attribute: ADDITIONAL_INFO.

Supported API: false

Specified by:

getAdditionalInfo in interface MarkUp

Returns:

String

setAdditionalInfo

public void setAdditionalInfo(String a_AdditionalInfo)
                       throws WTPropertyVetoException

Sets the value of the attribute: ADDITIONAL_INFO.

Supported API: false

Specified by:

setAdditionalInfo in interface MarkUp

Parameters:

a_AdditionalInfo -

Throws:

WTPropertyVetoException

additionalInfoValidate

private void additionalInfoValidate(String a_AdditionalInfo)
                             throws WTPropertyVetoException

Parameters:

a_AdditionalInfo -

Throws:

WTPropertyVetoException

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: false

Specified by:

getName in interface MarkUp

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME.

Supported API: false

Specified by:

setName in interface MarkUp

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getIdentity

public String getIdentity()

Supported API: false

Specified by:

getIdentity in interface MarkUp

Overrides:

getIdentity in class WTObject

Returns:

String

getMarkUpType

public MarkUpType getMarkUpType()

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

Supported API: false

Specified by:

getMarkUpType in interface MarkUp

Returns:

MarkUpType

setMarkUpType

public void setMarkUpType(MarkUpType a_MarkUpType)
                   throws WTPropertyVetoException

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

Supported API: false

Specified by:

setMarkUpType in interface MarkUp

Parameters:

a_MarkUpType -

Throws:

WTPropertyVetoException

MarkUpTypeValidate

private void MarkUpTypeValidate(MarkUpType a_MarkUpType)
                         throws WTPropertyVetoException

Parameters:

a_MarkUpType -

Throws:

WTPropertyVetoException

getFormatName

public String getFormatName()

Gets the value of the attribute: FORMAT_NAME.

Supported API: false

Specified by:

getFormatName in interface FormatContentHolder

Returns:

String

getPrimary

public ContentItem getPrimary()

Gets the value of the attribute: PRIMARY. This is a non-persistent ContentItem for FormatContentHolders that is used to pass the primary content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getPrimary in interface FormatContentHolder

Returns:

ContentItem

setPrimary

public void setPrimary(ContentItem a_Primary)
                throws WTPropertyVetoException

Sets the value of the attribute: PRIMARY. This is a non-persistent ContentItem for FormatContentHolders that is used to pass the primary content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setPrimary in interface FormatContentHolder

Parameters:

a_Primary -

Throws:

WTPropertyVetoException

getFormat

public DataFormatReference getFormat()

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

Supported API: false

Specified by:

getFormat in interface FormatContentHolder

Returns:

DataFormatReference

setFormat

public void setFormat(DataFormatReference a_Format)
               throws WTPropertyVetoException

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

Supported API: false

Specified by:

setFormat in interface FormatContentHolder

Parameters:

a_Format -

Throws:

WTPropertyVetoException

formatValidate

private void formatValidate(DataFormatReference a_Format)
                     throws WTPropertyVetoException

Parameters:

a_Format -

Throws:

WTPropertyVetoException

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

isLocked

public boolean isLocked()

Gets the value of the attribute: LOCKED. Derived attribute for displaying the isSeized value in query results.

Supported API: false

Specified by:

isLocked in interface Lockable

Returns:

boolean

getLockDate

public Timestamp getLockDate()

Gets the value of the attribute: LOCK_DATE. Derived attribute for displaying the lock date value in query results.

Supported API: false

Specified by:

getLockDate in interface Lockable

Returns:

Timestamp

getLockNote

public String getLockNote()

Gets the value of the attribute: LOCK_NOTE. Derived attribute for displaying the lock note value in query results.

Supported API: false

Specified by:

getLockNote in interface Lockable

Returns:

String

getLocker

public WTPrincipalReference getLocker()

Gets the value of the attribute: LOCKER. Derived attribute for querying for the locker.

Supported API: false

Specified by:

getLocker in interface Lockable

Returns:

WTPrincipalReference

getLockerEMail

public String getLockerEMail()

Gets the value of the attribute: LOCKER_EMAIL. Derived attribute for displaying the locker E-Mail value in query results.

Supported API: false

Specified by:

getLockerEMail in interface Lockable

Returns:

String

getLockerName

public String getLockerName()

Gets the value of the attribute: LOCKER_NAME. Derived attribute for displaying the locker name value in query results.

Supported API: false

Specified by:

getLockerName in interface Lockable

Returns:

String

getLockerFullName

public String getLockerFullName()

Gets the value of the attribute: LOCKER_FULL_NAME. Derived attribute for displaying the lock fullname value in query results.

Supported API: false

Specified by:

getLockerFullName in interface Lockable

Returns:

String

getLock

public Lock getLock()

Gets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Specified by:

getLock in interface Lockable

Returns:

Lock

See Also:

Lock

setLock

public void setLock(Lock a_Lock)
             throws WTPropertyVetoException

Sets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Specified by:

setLock in interface Lockable

Parameters:

a_Lock -

Throws:

WTPropertyVetoException

See Also:

Lock

lockValidate

private void lockValidate(Lock a_Lock)
                   throws WTPropertyVetoException

Parameters:

a_Lock -

Throws:

WTPropertyVetoException

getOwnership

public Ownership getOwnership()

Gets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

getOwnership in interface Ownable

Returns:

Ownership

setOwnership

public void setOwnership(Ownership a_Ownership)

Sets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

setOwnership in interface Ownable

Parameters:

a_Ownership -

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 Item

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 Item

Returns:

int