wt.workflow.forum
Interface ForumTemplate

All Superinterfaces:

NetFactor, ObjectMappable, Persistable, Serializable

public interface ForumTemplate

extends Persistable

This class serves as an interface for Templates that contain a pre-defined forum structure. All forums instantiated by a template instance inherit the structure of that template. The structure of the template is represented in XML notation and is stored as a string in the XMLLob. A DTD is used to validate the structure in the UI. Only a valid structure is persisted in the database. See Also : DiscussionForumTemplate

Field Summary

static String	DESCRIPTION Label for the attribute; The description for the template
static String	DOC_TYPE
static String	DTD_LOCATION
static String	NAME Label for the attribute; The name of the template.
static String	STRUCTURE Label for the attribute; The container of the structure of the template.
static String	XML_VERSION

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Method Summary

boolean	canDelete() Checks if this template can be deleted or not.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
Vector	getForums() Retrieves all the Forum instances that are based on this template.
String	getName() Gets the value of the attribute: NAME.
XMLLob	getStructure() Gets the value of the attribute: STRUCTURE.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setStructure(XMLLob a_Structure) Sets the value of the attribute: STRUCTURE.

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

NAME

public static final String NAME

Label for the attribute; The name of the template.

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute; The description for the template

See Also:

Constant Field Values

STRUCTURE

public static final String STRUCTURE

Label for the attribute; The container of the structure of the template. The structure is a String represented in XML notation.

See Also:

Constant Field Values

XML_VERSION

public static final String XML_VERSION

See Also:

Constant Field Values

DTD_LOCATION

public static final String DTD_LOCATION

See Also:

Constant Field Values

DOC_TYPE

public static final String DOC_TYPE

See Also:

Constant Field Values

Method Detail

getName

public String getName()

Gets the value of the attribute: NAME. The name of the template.

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. The name of the template.

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. The description for the template

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. The description for the template

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getStructure

public XMLLob getStructure()

Gets the value of the attribute: STRUCTURE. The container of the structure of the template. The structure is a String represented in XML notation.

Returns:

XMLLob

setStructure

public void setStructure(XMLLob a_Structure)
                  throws WTPropertyVetoException

Sets the value of the attribute: STRUCTURE. The container of the structure of the template. The structure is a String represented in XML notation.

Parameters:

a_Structure -

Throws:

WTPropertyVetoException

getForums

public Vector getForums()

Retrieves all the Forum instances that are based on this template.

Returns:

Vector

canDelete

public boolean canDelete()
                  throws WTException

Checks if this template can be deleted or not. Returns false if there are Forum instances based on this template and true otherwise.

Returns:

boolean

Throws:

WTException