| com.flexive.shared.interfaces.TemplateEngine
All known Subclasses: com.flexive.ejb.beans.TemplateEngineBean,
| TemplateEngine | | public interface TemplateEngine (Code) | | |
| Inner Class :public static enum Type | |
| Method Summary | |
| public void | activate(long id)
| | public long | create(String name, Type type, String contentType, String content)
| | public String | getContent(long id, FxTreeMode mode)
Retrives the content from the template. | | public String | getContent(String templateName, FxTreeMode mode)
Retrives the content from the template. | | public String | getFinalContent(long id, String masterTemplateFile, FxTreeMode mode)
Retrives the final content from the template. | | public String | getFinalContent(String templateName, String masterTemplateFile)
Retrives the final content from the template. | | public FxTemplateInfo | getInfo(long id, FxTreeMode mode)
| | public FxTemplateInfo | getInfo(String name, FxTreeMode mode)
| | public long | getLastChange(Type type, FxTreeMode mode)
Returns the last change time of any item matching the given type. | | public FxTemplateInfo | getTemplate(long treeNodeId, FxTreeMode mode)
Gets the template for the specified node id. | | public ArrayList<FxTemplateMapping> | getTemplateMappings(long treeNodeId, FxTreeMode mode)
| | public ArrayList<FxTemplateInfo> | list(Type type)
| | public void | setContent(long id, String content, String type, FxTreeMode mode)
| | public void | setName(long id, String name)
Renames a existing template. | | public void | setTemplateMappings(long nodeId, List<FxTemplateMapping> map)
| | public boolean | templateIsReferenced(long id)
Returns true if the template is used by other templates. |
| getContent | | public String getContent(long id, FxTreeMode mode) throws FxApplicationException(Code) | | Retrives the content from the template.
This function returns the content represented to the users for editing, while the getFinalContent(id) function
returns the text that is use by the application server to generate the pages.
Parameters:
id - the template id
Parameters:
mode - tree mode the content
throws:
FxApplicationException - if the function fails |
| getContent | | public String getContent(String templateName, FxTreeMode mode) throws FxApplicationException(Code) | | Retrives the content from the template.
This function returns the content represented to the users for editing, while the getFinalContent(id) function
returns the text that is use by the application server to generate the pages.
Parameters:
templateName - the template name
Parameters:
mode - tree mode the final content
throws:
FxApplicationException - if the function fails |
| getFinalContent | | public String getFinalContent(long id, String masterTemplateFile, FxTreeMode mode) throws FxApplicationException(Code) | | Retrives the final content from the template.
The "final" content is the text that is use by the application server to generate the pages.
Parameters:
id - the template id
Parameters:
mode - tree mode
Parameters:
masterTemplateFile - The absolute filesystem name of the master template file the final content
throws:
FxApplicationException - if the function fails |
| getFinalContent | | public String getFinalContent(String templateName, String masterTemplateFile) throws FxApplicationException(Code) | | Retrives the final content from the template.
The "final" content is the text that is use by the application server to generate the pages.
Parameters:
templateName - the template name
Parameters:
masterTemplateFile - The absolute filesystem name of the master template file the final content
throws:
FxApplicationException - if the function fails |
| getLastChange | | public long getLastChange(Type type, FxTreeMode mode)(Code) | | Returns the last change time of any item matching the given type.
Parameters:
type - the type, may be null for the last 'global' change timestamp
Parameters:
mode - tree mode the last change time |
| templateIsReferenced | | public boolean templateIsReferenced(long id) throws FxLoadException(Code) | | Returns true if the template is used by other templates.
Parameters:
id - the id of the templates true if the template is used by other templates.
throws:
FxLoadException - if the function failed |
|
|