atg.portal.framework

Interface PageTemplate

public interface PageTemplate

Represents a page templates

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthor() Access the author
java.util.Date	getCreationDate() Access the creation date
java.lang.String	getDescription() Access the description of the page template
java.lang.String	getDescription(java.util.Locale locale)
DisplayMode	getDisplayMode(java.lang.String pDisplayMode) Access a named display mode from the page tempate
DisplayMode[]	getDisplayModes() Access all display modes
java.lang.String	getId() Access the id
java.lang.String	getLargeImageURL() Access the large image URL
java.util.Date	getLastModified() Access the last modified date
java.lang.String	getName() Deprecated.
java.lang.String	getName(java.util.Locale locale) Gets the name of the page template in the language of the given locale
java.lang.String	getServletContext() Access the servlet context
java.lang.String	getSmallImageURL() Access the small image URL
java.lang.String	getVersion() Access the version of the page template
boolean	hasDisplayMode(java.lang.String pDisplayMode) Returns true if this page tempalte has a particuar display mode
void	setAuthor(java.lang.String pAuthor) Set the author of the page template
void	setDescription(java.lang.String pDescription) Set the description of the page template
void	setDescription(java.lang.String description, java.util.Locale locale)
void	setDisplayModes(DisplayMode pDisplayModes) Set the display modes property
void	setImage(java.lang.String pProperty, java.lang.String pImageUrl) Set the image property passed of the page template
void	setName(java.lang.String pName) Set the name of the page template
void	setName(java.lang.String name, java.util.Locale locale)
void	setServletContext(java.lang.String pServletContext) Set the servlet context of the page template
void	setVersion(java.lang.String pVersion) Set the version of the page template

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Access the id

Returns:

an id

getName

java.lang.String getName()

Deprecated.

Access the name of the page template

Returns:

a name

getName

java.lang.String getName(java.util.Locale locale)

Gets the name of the page template in the language of the given locale

setName

void setName(java.lang.String pName)

Set the name of the page template

Parameters:

a - name

setName

void setName(java.lang.String name,
             java.util.Locale locale)

getDescription

java.lang.String getDescription()

Access the description of the page template

Returns:

a description

getDescription

java.lang.String getDescription(java.util.Locale locale)

setDescription

void setDescription(java.lang.String pDescription)

Set the description of the page template

Parameters:

a - description

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale)

getCreationDate

java.util.Date getCreationDate()

Access the creation date

Returns:

a date

getLastModified

java.util.Date getLastModified()

Access the last modified date

Returns:

a date

getVersion

java.lang.String getVersion()

Access the version of the page template

Returns:

a version

setVersion

void setVersion(java.lang.String pVersion)

Set the version of the page template

Parameters:

a - version

getAuthor

java.lang.String getAuthor()

Access the author

Returns:

an author

setAuthor

void setAuthor(java.lang.String pAuthor)

Set the author of the page template

Parameters:

a - author

getSmallImageURL

java.lang.String getSmallImageURL()

Access the small image URL

Returns:

the small image url

setImage

void setImage(java.lang.String pProperty,
              java.lang.String pImageUrl)

Set the image property passed of the page template

Parameters:

an - image property

an - image Url

getLargeImageURL

java.lang.String getLargeImageURL()

Access the large image URL

Returns:

the large image url

getServletContext

java.lang.String getServletContext()

Access the servlet context

Returns:

a servlet context

setServletContext

void setServletContext(java.lang.String pServletContext)

Set the servlet context of the page template

Parameters:

a - servlet context

hasDisplayMode

boolean hasDisplayMode(java.lang.String pDisplayMode)

Returns true if this page tempalte has a particuar display mode

Parameters:

pDisplayMode - the name of a display mode

Returns:

true if display mode exists, false otherwise

getDisplayMode

DisplayMode getDisplayMode(java.lang.String pDisplayMode)

Access a named display mode from the page tempate

Parameters:

pDisplayMode - the name of a display mode

Returns:

a display mode

getDisplayModes

DisplayMode[] getDisplayModes()

Access all display modes

Returns:

an array of display modes

setDisplayModes

void setDisplayModes(DisplayMode pDisplayModes)

Set the display modes property

Parameters:

a - displayModes