Package org.silverpeas.core.webapi.documenttemplate

Class DocumentTemplateEntity

java.lang.Object

org.silverpeas.core.webapi.documenttemplate.DocumentTemplateEntity

All Implemented Interfaces:

Serializable, WebEntity

public class DocumentTemplateEntity
extends Object
implements WebEntity

The DocumentTemplateEntity entity is a DocumentTemplate that is exposed in the web as an entity (web entity). As such, it publishes only some of its attributes. It represents a document template in Silverpeas.

Author:

silveryocha

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DocumentTemplateEntity()	Default constructor
	DocumentTemplateEntity(DocumentTemplate documentTemplate, URI uri, String language)	Constructor using DocumentTemplate and uri.

Method Summary

Modifier and Type	Method	Description
static DocumentTemplateEntity	from(DocumentTemplate documentTemplate, URI uri, String language)
String	getDescription()
String	getId()
String	getName()
PreviewEntity	getPreview()
URI	getURI()	Gets the URI at which this web entity is published and can be accessed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentTemplateEntity

protected DocumentTemplateEntity()

Default constructor

DocumentTemplateEntity

public DocumentTemplateEntity(DocumentTemplate documentTemplate,
                              URI uri,
                              String language)

Constructor using DocumentTemplate and uri.

Parameters:

documentTemplate - the document template data.

uri - an URI.

Method Detail

from

public static DocumentTemplateEntity from(DocumentTemplate documentTemplate,
                                          URI uri,
                                          String language)

getId

public String getId()

getName

public String getName()

getDescription

public String getDescription()

getPreview

public PreviewEntity getPreview()

getURI

public URI getURI()

Description copied from interface: WebEntity

Gets the URI at which this web entity is published and can be accessed.

Specified by:

getURI in interface WebEntity

Returns:

the web entity URI.