Package com.day.cq.wcm.api

Interface Template

All Superinterfaces:

Adaptable, JSONItem, LabeledResource

@ProviderType
public interface Template
extends Adaptable, LabeledResource, JSONItem

Defines the interface of a CQ WCM template.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description of the template or null if not defined.
String	getIconPath()	Returns the path to an icon for this template or null if this template does not provide an icon.
String	getInitialContentPath()	Get the initial content path.
Calendar	getLastModified()	Get last modified date of template.
String	getPageTypePath()	Get page type
String	getPath()	Returns the path of the template resource
ValueMap	getProperties()	Get the template's properties.
Long	getRanking()	Returns the ranking in the template list.
String	getShortTitle()	Returns the short title of the template or null if not defined.
String	getThumbnailPath()	Returns the path to a thumbnail for this template or null if the template does not provide a thumbnail.
String	getTitle()	Returns the title of the template or the name of the resource (i.e.
boolean	hasStructureSupport()	Check if it has structure support.
boolean	isAllowed(String parentPath)	Checks if this template is allowed to be used for a new page below the given path.
boolean	isAllowed(Resource parent)	Checks if this template is allowed to be used for a new page below the given parent.
boolean	isAllowedChild(Template template)	Checks if the given template is allowed as a child template.
void	write(JSONWriter jsonWriter)	Serializes this descriptor to json

Methods inherited from interface org.apache.sling.api.adapter.Adaptable

adaptTo

Methods inherited from interface com.day.cq.commons.LabeledResource

getName

Method Detail

getPath

String getPath()

Returns the path of the template resource

Specified by:

getPath in interface LabeledResource

Returns:

path

getTitle

String getTitle()

Returns the title of the template or the name of the resource (i.e. last path segment) if not defined.

Specified by:

getTitle in interface LabeledResource

Returns:

title

getShortTitle

String getShortTitle()

Returns the short title of the template or null if not defined.

Returns:

short title

getDescription

String getDescription()

Returns the description of the template or null if not defined.

Specified by:

getDescription in interface LabeledResource

Returns:

description

getIconPath

String getIconPath()

Returns the path to an icon for this template or null if this template does not provide an icon.

Returns:

the path to an icon or null

getThumbnailPath

String getThumbnailPath()

Returns the path to a thumbnail for this template or null if the template does not provide a thumbnail.

Returns:

the path to a thumbnail or null

getRanking

Long getRanking()

Returns the ranking in the template list.

Returns:

the ranking

isAllowed

boolean isAllowed(String parentPath)

Checks if this template is allowed to be used for a new page below the given path. Note: This template is not allowed, if the parent template cannot be evaluated but the template specifies "allowedParents" Always use isAllowed(Resource) in loops for better performance.

Parameters:

parentPath - parent path for the new page

Returns:

true if it is allowed.

isAllowed

boolean isAllowed(Resource parent)

Checks if this template is allowed to be used for a new page below the given parent. Note: This template is not allowed, if the parent template cannot be evaluated but the template specifies "allowedParents"

Parameters:

parent - the parent resource for the new page

Returns:

true if it is allowed.

isAllowedChild

boolean isAllowedChild(Template template)

Checks if the given template is allowed as a child template.

Parameters:

template - the child template

Returns:

true if the given template is allowed as child template.

write

void write(JSONWriter jsonWriter)
    throws JSONException

Serializes this descriptor to json

Specified by:

write in interface JSONItem

Parameters:

jsonWriter - json writer

Throws:

JSONException - if a JSON error occurs

getInitialContentPath

String getInitialContentPath()

Get the initial content path.

Returns:

String the initial content path.

getProperties

ValueMap getProperties()

Get the template's properties.

Returns:

The template's properties. Never returns null.

hasStructureSupport

boolean hasStructureSupport()

Check if it has structure support.

Returns:

boolean.

getPageTypePath

String getPageTypePath()

Get page type

Returns:

page type.

getLastModified

Calendar getLastModified()

Get last modified date of template.

Returns:

last modified date of template.