wt.content
Interface FormatContentHolder

All Superinterfaces:

ContentHolder, NetFactor, ObjectMappable, Persistable, Serializable

All Known Subinterfaces:

ElectronicIdentification, EPMFamilyTable, MarkUp, Representation

All Known Implementing Classes:

DerivedImage, ElectronicSignature, EPMDocument, EPMSepFamilyTable, ImportSession, MeetingDeliverable, WTDocument, WTMarkUp

public interface FormatContentHolder

extends ContentHolder

This interface should be used on those ContentHolders that want to store a primary format (for mainly display purposes). For example, the WTDocument in wt.doc that are displayed based on their content implment this interface. The behavoir of FormatContentHolders is similar to ContentHolders, except that their primary format of them will be set as content changes in the holder.

Supported API: true

Extendable: true

See Also:

ContentHolder, WTDocument

Field Summary

static String	FORMAT Label for the attribute.
static String	FORMAT_NAME Label for the attribute.
static String	PRIMARY Label for the attribute; This is a non-persistent ContentItem for FormatContentHolders that is used to pass the primary content from server to client.

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

Method Summary

DataFormatReference	getFormat() Gets the object for the association that plays role: FORMAT.
String	getFormatName() Gets the value of the attribute: FORMAT_NAME.
ContentItem	getPrimary() Gets the value of the attribute: PRIMARY.
void	setFormat(DataFormatReference a_Format) Sets the object for the association that plays role: FORMAT.
void	setPrimary(ContentItem a_Primary) Sets the value of the attribute: PRIMARY.

Methods inherited from interface wt.content.ContentHolder

getContentVector, getHttpVector, getOperation, isHasContents, setContentVector, setHasContents, setHttpVector, setOperation

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.ObjectMappable

readExternal, writeExternal

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Field Detail

FORMAT_NAME

public static final String FORMAT_NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

PRIMARY

public static final String PRIMARY

Label for the attribute; 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

See Also:

Constant Field Values

FORMAT

public static final String FORMAT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

Method Detail

getFormatName

public String getFormatName()

Gets the value of the attribute: FORMAT_NAME.

Supported API: false

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

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

Parameters:

a_Primary -

Throws:

WTPropertyVetoException

getFormat

public DataFormatReference getFormat()

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

Supported API: false

Returns:

DataFormatReference

setFormat

public void setFormat(DataFormatReference a_Format)
               throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_Format -

Throws:

WTPropertyVetoException