public interface PageTemplate
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
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
|
static final java.lang.String CLASS_VERSION
java.lang.String getId()
java.lang.String getName()
java.lang.String getName(java.util.Locale locale)
void setName(java.lang.String pName)
a
- namevoid setName(java.lang.String name, java.util.Locale locale)
java.lang.String getDescription()
java.lang.String getDescription(java.util.Locale locale)
void setDescription(java.lang.String pDescription)
a
- descriptionvoid setDescription(java.lang.String description, java.util.Locale locale)
java.util.Date getCreationDate()
java.util.Date getLastModified()
java.lang.String getVersion()
void setVersion(java.lang.String pVersion)
a
- versionjava.lang.String getAuthor()
void setAuthor(java.lang.String pAuthor)
a
- authorjava.lang.String getSmallImageURL()
void setImage(java.lang.String pProperty, java.lang.String pImageUrl)
an
- image propertyan
- image Urljava.lang.String getLargeImageURL()
java.lang.String getServletContext()
void setServletContext(java.lang.String pServletContext)
a
- servlet contextboolean hasDisplayMode(java.lang.String pDisplayMode)
pDisplayMode
- the name of a display modeDisplayMode getDisplayMode(java.lang.String pDisplayMode)
pDisplayMode
- the name of a display modeDisplayMode[] getDisplayModes()
void setDisplayModes(DisplayMode pDisplayModes)
a
- displayModes