Package com.atlassian.confluence.pages.templates

Class PageTemplate

java.lang.Object

com.atlassian.core.bean.EntityObject

com.atlassian.confluence.core.ConfluenceEntityObject

com.atlassian.confluence.core.AbstractVersionedEntityObject

com.atlassian.confluence.core.AbstractLabelableEntityObject

com.atlassian.confluence.pages.templates.PageTemplate

All Implemented Interfaces:

Versioned, EditableLabelable, Labelable, Serializable, Cloneable

public class PageTemplate
extends AbstractLabelableEntityObject

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	LABEL_SEPARATOR	The String used to separate the labels.

Fields inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject

INITIAL_VERSION

Constructor Summary

Constructors

Constructor	Description
PageTemplate()
PageTemplate(PageTemplate pageTemplate)

Method Summary

Modifier and Type	Method	Description
void	convertToHistoricalVersion()	Remove all data from the object that does not need to be saved by historical versions.
boolean	equals(Object o)
BodyType	getBodyType()
String	getContent()
ContentTemplateId	getContentTemplateId()
String	getDescription()
PageTemplate	getLatestVersion()	Get the latest, current version of this versioned object.
com.atlassian.plugin.ModuleCompleteKey	getModuleCompleteKey()
String	getModuleKey()
String	getName()
PageTemplate	getOriginalVersionPageTemplate()
String	getPluginKey()
com.atlassian.plugin.ModuleCompleteKey	getReferencingModuleCompleteKey()
String	getReferencingModuleKey()
String	getReferencingPluginKey()
Space	getSpace()	The space this page template is constrained to.
String	getTitle()
int	hashCode()
boolean	isGlobalPageTemplate()
void	setBodyType(BodyType bodyType)
void	setContent(String content)
void	setDescription(String description)
void	setModuleCompleteKey(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey)
void	setName(String name)
void	setOriginalVersionPageTemplate(PageTemplate originalVersionPageTemplate)
void	setReferencingModuleCompleteKey(com.atlassian.plugin.ModuleCompleteKey referencingModuleCompleteKey)
void	setReferencingModuleKey(String referencingModuleKey)
void	setReferencingPluginKey(String referencingPluginKey)
void	setSpace(Space space)

Methods inherited from class com.atlassian.confluence.core.AbstractLabelableEntityObject

addLabelling, clone, getGlobalLabels, getLabelCount, getLabellings, getLabels, getLabelsForDisplay, getPersonalLabels, getTeamLabels, getVisibleLabels, isFavourite, removeLabelling, setLabellings

Methods inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject

applyChildVersioningPolicy, applyChildVersioningPolicy, getConfluenceRevision, getVersion, getVersionChildPolicy, isLatestVersion, isNew, setOriginalVersion, setVersion

Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject

getCreator, getCreatorName, getLastModifier, getLastModifierName, getRealClass, isPersistent, setCreator, setCreatorName, setLastModifier, setLastModifierName

Methods inherited from class com.atlassian.core.bean.EntityObject

getCreationDate, getCurrentDate, getId, getLastModificationDate, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.labels.EditableLabelable

getId, isPersistent

Field Detail

LABEL_SEPARATOR

public static final String LABEL_SEPARATOR

The String used to separate the labels.

See Also:

Constant Field Values

Constructor Detail

PageTemplate

public PageTemplate()

PageTemplate

public PageTemplate(PageTemplate pageTemplate)

Method Detail

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getContent

public String getContent()

setContent

public void setContent(String content)

getSpace

public Space getSpace()

The space this page template is constrained to.

setSpace

public void setSpace(Space space)

setModuleCompleteKey

public void setModuleCompleteKey(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey)

setReferencingModuleCompleteKey

public void setReferencingModuleCompleteKey(com.atlassian.plugin.ModuleCompleteKey referencingModuleCompleteKey)

getModuleCompleteKey

public com.atlassian.plugin.ModuleCompleteKey getModuleCompleteKey()

getReferencingModuleCompleteKey

public com.atlassian.plugin.ModuleCompleteKey getReferencingModuleCompleteKey()

getModuleKey

public String getModuleKey()

getPluginKey

public String getPluginKey()

getOriginalVersionPageTemplate

public PageTemplate getOriginalVersionPageTemplate()

getLatestVersion

public PageTemplate getLatestVersion()

Description copied from interface: Versioned

Get the latest, current version of this versioned object. If this object is the current version, return this object.

Note that drafts are a special version of a ContentEntityObject so for drafts this method should return the ContentEntityObject the drafts points to if it exists and the draft itself otherwise.

Specified by:

getLatestVersion in interface Versioned

Overrides:

getLatestVersion in class AbstractVersionedEntityObject

Returns:

the current version of this object.

See Also:

ContentEntityObject.DRAFT

setOriginalVersionPageTemplate

public void setOriginalVersionPageTemplate(PageTemplate originalVersionPageTemplate)

isGlobalPageTemplate

public boolean isGlobalPageTemplate()

equals

public boolean equals(Object o)

Overrides:

equals in class com.atlassian.core.bean.EntityObject

hashCode

public int hashCode()

Overrides:

hashCode in class com.atlassian.core.bean.EntityObject

convertToHistoricalVersion

public void convertToHistoricalVersion()

Description copied from interface: Versioned

Remove all data from the object that does not need to be saved by historical versions. For versioned objects that are persisted, this includes removing associations with other persisted objects that may otherwise cause us to break the expected arity of the database relations.

When using Hibernate to persist versioned objects, take special care to null any field that might contain a Hibernate-persisted collection, as Hibernate does not allow two different persistent objects to refer to the same persisted collection at the same time.

Specified by:

convertToHistoricalVersion in interface Versioned

Overrides:

convertToHistoricalVersion in class AbstractVersionedEntityObject

getTitle

public String getTitle()

getBodyType

public BodyType getBodyType()

setBodyType

public void setBodyType(BodyType bodyType)

getReferencingPluginKey

public String getReferencingPluginKey()

setReferencingPluginKey

public void setReferencingPluginKey(String referencingPluginKey)

getReferencingModuleKey

public String getReferencingModuleKey()

setReferencingModuleKey

public void setReferencingModuleKey(String referencingModuleKey)

getContentTemplateId

public ContentTemplateId getContentTemplateId()