org.springframework.extensions.surf
Interface ModelObject

All Superinterfaces:

Serializable

All Known Subinterfaces:

Chrome, Component, ComponentType, Configuration, ContentAssociation, Page, PageAssociation, PageType, TemplateInstance, TemplateType, Theme

All Known Implementing Classes:

AbstractModelObject, AbstractRenderableModelObject, ChromeImpl, ComponentImpl, ComponentTypeImpl, ConfigurationImpl, ContentAssociationImpl, ModelObjectCache.ModelObjectSentinel, PageAssociationImpl, PageImpl, PageTypeImpl, TemplateInstanceImpl, TemplateTypeImpl, ThemeImpl

public interface ModelObject
extends Serializable

Author:

muzquiano

Field Summary

static String	PROP_DESCRIPTION
static String	PROP_DESCRIPTION_ID
static String	PROP_ID
static String	PROP_TITLE
static String	PROP_TITLE_ID

Method Summary

boolean	getBooleanProperty(String propertyName)
Map<String,Serializable>	getCustomProperties()
String	getCustomProperty(String propertyName)
String	getDescription() Returns the description property of the model object
String	getDescriptionId() Returns the description id property of the model object
org.dom4j.Document	getDocument()
String	getId() Returns the id of the model object.
ModelPersisterInfo	getKey() Returns the model object key instance
Map<String,Serializable>	getModelProperties()
String	getModelProperty(String propertyName)
String	getModelVersion()
long	getModificationTime()
String	getPersisterId()
Map<String,Serializable>	getProperties()
String	getProperty(String propertyName)
String	getStoragePath()
String	getTitle() Returns the title property of the model object.
String	getTitleId() Returns the title id property of the model object.
String	getTypeId() Returns the type id of the model object.
boolean	isSaved() Indicates whether the object is currently persisted (saved) or not.
void	removeCustomProperty(String propertyName)
void	removeModelProperty(String propertyName)
void	removeProperty(String propertyName)
void	setCustomProperty(String propertyName, String propertyValue)
void	setDescription(String value) Sets the description property of the model object
void	setDescriptionId(String value) Sets the description id property of the model object
void	setModelProperty(String propertyName, String propertyValue)
void	setProperty(String propertyName, String propertyValue)
void	setTitle(String value) Sets the title property of the model object
void	setTitleId(String value) Sets the title id property of the model object
void	touch()
String	toXML() Serializes the object to XML.

Field Detail

PROP_ID

static final String PROP_ID

See Also:

Constant Field Values

PROP_TITLE

static final String PROP_TITLE

See Also:

Constant Field Values

PROP_TITLE_ID

static final String PROP_TITLE_ID

See Also:

Constant Field Values

PROP_DESCRIPTION

static final String PROP_DESCRIPTION

See Also:

Constant Field Values

PROP_DESCRIPTION_ID

static final String PROP_DESCRIPTION_ID

See Also:

Constant Field Values

Method Detail

getKey

ModelPersisterInfo getKey()

Returns the model object key instance

Returns:

getId

String getId()

Returns the id of the model object.

Returns:

The id

getTypeId

String getTypeId()

Returns the type id of the model object.

Returns:

The type id

getTitle

String getTitle()

Returns the title property of the model object.

Returns:

The title

setTitle

void setTitle(String value)

Sets the title property of the model object

Parameters:

The - new title

getTitleId

String getTitleId()

Returns the title id property of the model object.

Returns:

The title id

setTitleId

void setTitleId(String value)

Sets the title id property of the model object

Parameters:

The - new title id

getDescription

String getDescription()

Returns the description property of the model object

Returns:

The description

setDescription

void setDescription(String value)

Sets the description property of the model object

Parameters:

The - description

getDescriptionId

String getDescriptionId()

Returns the description id property of the model object

Returns:

The description id

setDescriptionId

void setDescriptionId(String value)

Sets the description id property of the model object

Parameters:

The - description id

isSaved

boolean isSaved()

Indicates whether the object is currently persisted (saved) or not. A new object will have this flag set to false prior to a save and true once the save operation has completed.

Returns:

Whether the object is currently saved

toXML

String toXML()

Serializes the object to XML. By default, this uses a pretty XML renderer so that the resulting XML is human readable.

Returns:

The XML string

getBooleanProperty

boolean getBooleanProperty(String propertyName)

getProperty

String getProperty(String propertyName)

setProperty

void setProperty(String propertyName,
                 String propertyValue)

removeProperty

void removeProperty(String propertyName)

getProperties

Map<String,Serializable> getProperties()

getModelProperty

String getModelProperty(String propertyName)

setModelProperty

void setModelProperty(String propertyName,
                      String propertyValue)

removeModelProperty

void removeModelProperty(String propertyName)

getModelProperties

Map<String,Serializable> getModelProperties()

getCustomProperty

String getCustomProperty(String propertyName)

setCustomProperty

void setCustomProperty(String propertyName,
                       String propertyValue)

removeCustomProperty

void removeCustomProperty(String propertyName)

getCustomProperties

Map<String,Serializable> getCustomProperties()

getStoragePath

String getStoragePath()

getPersisterId

String getPersisterId()

getModificationTime

long getModificationTime()

touch

void touch()

getModelVersion

String getModelVersion()

getDocument

org.dom4j.Document getDocument()