com.fatwire.services.beans.asset.basic.template

Class TemplateBean

java.lang.Object

com.fatwire.services.beans.BaseBean

com.fatwire.services.beans.asset.AssetBean

com.fatwire.services.beans.asset.basic.template.TemplateBean

All Implemented Interfaces:

Serializable

public final class TemplateBean
extends AssetBean

The TemplateBean encapsulates layout properties. A template is a system asset type which is used to render an asset. For referential purposes, the template name is the name of the template if this template is applicable to a specific asset type. The template name is pre-pended with a leading forward slash character ("/") in case of typeless templates (templates which can apply to various asset types). The ThumnailURL points to the Image Renderer Servlet. Optional thumbnail parameters can be passed to the url for scaling the image.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateBean.Type Enumerates all the supported template types.

Nested classes/interfaces inherited from class com.fatwire.services.beans.asset.AssetBean

AssetBean.Status

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEMPLATE Name of the Template asset type.

Fields inherited from class com.fatwire.services.beans.asset.AssetBean

attributes, description, id, name, type

Constructor Summary

Constructors

Constructor and Description
TemplateBean() Default Constructor which sets the type of Template assets to "Template".

Method Summary

Modifier and Type	Method and Description
String	getPageName()
TemplateBean.Type	getTemplateType() Returns the type of this template.
String	getThumbnailUrl() Returns the relative path of the thumbnail if available.
String	getTname() Returns the type-qualified template name associated with this template.
Boolean	isTypeless() Returns a flag to indicate if this template is typeless.
void	setId(AssetId id) Sets the identifier for this asset.
void	setPageName(String pagename)
void	setTemplateType(TemplateBean.Type templateType) Sets the type of this template.
void	setThumbnailUrl(String thumbnailUrl) Sets the relative path of this thumbnail.
void	setTname(String templateName)
void	setType(TypeBean type) Sets the type for this asset.
void	setTypeless(boolean typeless)

Methods inherited from class com.fatwire.services.beans.asset.AssetBean

getAttributes, getDescription, getId, getName, getType, setDescription, setName

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATE

public static final String TEMPLATE

Name of the Template asset type.

See Also:

Constant Field Values

Constructor Detail

TemplateBean

public TemplateBean()

Default Constructor which sets the type of Template assets to "Template".

Method Detail

setId

public void setId(AssetId id)

Description copied from class: AssetBean

Sets the identifier for this asset.

Overrides:

setId in class AssetBean

Parameters:

id - the id to set for this asset.

setType

public void setType(TypeBean type)

Description copied from class: AssetBean

Sets the type for this asset.

Overrides:

setType in class AssetBean

Parameters:

type - the type to set for this asset.

getTname

public String getTname()

Returns the type-qualified template name associated with this template. For referential purposes, the template name is the name of the template if this template is applicable to a specific asset type. The template name is pre-pended with a leading forward slash character ("/") in case of typeless templates (templates which can apply to various asset types).

Returns:

the template name associated with this template.

setTname

public void setTname(String templateName)

getPageName

public String getPageName()

setPageName

public void setPageName(String pagename)

getTemplateType

public final TemplateBean.Type getTemplateType()

Returns the type of this template. see Type

Returns:

the templateType

setTemplateType

public final void setTemplateType(TemplateBean.Type templateType)

Sets the type of this template. see Type

Parameters:

templateType - the templateType to set

setTypeless

public void setTypeless(boolean typeless)

isTypeless

public final Boolean isTypeless()

Returns a flag to indicate if this template is typeless.

Returns:

true if this template is typeless, false otherwise.

getThumbnailUrl

public String getThumbnailUrl()

Returns the relative path of the thumbnail if available.

Returns:

relative path of the thumbnail if available.

setThumbnailUrl

public void setThumbnailUrl(String thumbnailUrl)

Sets the relative path of this thumbnail.

Parameters:

thumbnailUrl - a thumbnailUrl