001: /***************************************************************
002: * This file is part of the [fleXive](R) project.
003: *
004: * Copyright (c) 1999-2008
005: * UCS - unique computing solutions gmbh (http://www.ucs.at)
006: * All rights reserved
007: *
008: * The [fleXive](R) project is free software; you can redistribute
009: * it and/or modify it under the terms of the GNU General Public
010: * License as published by the Free Software Foundation;
011: * either version 2 of the License, or (at your option) any
012: * later version.
013: *
014: * The GNU General Public License can be found at
015: * http://www.gnu.org/copyleft/gpl.html.
016: * A copy is found in the textfile GPL.txt and important notices to the
017: * license from the author are found in LICENSE.txt distributed with
018: * these libraries.
019: *
020: * This library is distributed in the hope that it will be useful,
021: * but WITHOUT ANY WARRANTY; without even the implied warranty of
022: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
023: * GNU General Public License for more details.
024: *
025: * For further information about UCS - unique computing solutions gmbh,
026: * please see the company website: http://www.ucs.at
027: *
028: * For further information about [fleXive](R), please see the
029: * project website: http://www.flexive.org
030: *
031: *
032: * This copyright notice MUST APPEAR in all copies of the file!
033: ***************************************************************/package com.flexive.shared.interfaces;
034:
035: import com.flexive.shared.exceptions.FxApplicationException;
036: import com.flexive.shared.exceptions.FxLoadException;
037: import com.flexive.shared.tree.FxTemplateInfo;
038: import com.flexive.shared.tree.FxTemplateMapping;
039: import com.flexive.shared.tree.FxTreeMode;
040:
041: import javax.ejb.Remote;
042: import java.util.ArrayList;
043: import java.util.List;
044:
045: @Remote
046: /**
047: * Template Engine interface
048: *
049: * @author Gregor Schober (gregor.schober@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
050: */
051: public interface TemplateEngine {
052:
053: public static enum Type {
054: MASTER('M'), CONTENT('C'), TAG('T');
055: private char dbValue;
056:
057: Type(char dbValue) {
058: this .dbValue = dbValue;
059: }
060:
061: public char getDbValue() {
062: return dbValue;
063: }
064:
065: @Override
066: public String toString() {
067: return String.valueOf(dbValue);
068: }
069:
070: public static Type fromString(String s) {
071: if (s == null)
072: return null;
073: if (s.equalsIgnoreCase(MASTER.toString())) {
074: return MASTER;
075: } else if (s.equalsIgnoreCase(TAG.toString())) {
076: return TAG;
077: } else {
078: return CONTENT;
079: }
080: }
081: }
082:
083: /**
084: * Returns the last change time of any item matching the given type.
085: *
086: * @param type the type, may be null for the last 'global' change timestamp
087: * @param mode tree mode
088: * @return the last change time
089: */
090: public long getLastChange(Type type, FxTreeMode mode);
091:
092: public void activate(long id) throws FxApplicationException;
093:
094: public long create(String name, Type type, String contentType,
095: String content) throws FxApplicationException;
096:
097: /**
098: * Sets the content of the template
099: *
100: * @param id the templqates id
101: * @param content the content to set
102: * @param type the template type
103: * @param mode tree mode
104: * @throws FxApplicationException if the function fails
105: */
106: public void setContent(long id, String content, String type,
107: FxTreeMode mode) throws FxApplicationException;
108:
109: /**
110: * Returns true if the template is used by other templates.
111: *
112: * @param id the id of the templates
113: * @return true if the template is used by other templates.
114: * @throws FxLoadException if the function failed
115: */
116: public boolean templateIsReferenced(long id) throws FxLoadException;
117:
118: public FxTemplateInfo getInfo(long id, FxTreeMode mode)
119: throws FxApplicationException;
120:
121: public FxTemplateInfo getInfo(String name, FxTreeMode mode)
122: throws FxApplicationException;
123:
124: /**
125: * Renames a existing template.
126: *
127: * @param id the id of the template to rename
128: * @param name the new name
129: * @throws FxApplicationException if the rename failed
130: */
131: public void setName(long id, String name)
132: throws FxApplicationException;
133:
134: /**
135: * Loads all defined templates
136: *
137: * @param type the template type filter, or null
138: * @return the found templates
139: * @throws FxApplicationException if a error occured
140: */
141: public ArrayList<FxTemplateInfo> list(Type type)
142: throws FxApplicationException;
143:
144: /**
145: * Retrives the content from the template.
146: * <p/>
147: * This function returns the content represented to the users for editing, while the getFinalContent(id) function
148: * returns the text that is use by the application server to generate the pages.
149: *
150: * @param id the template id
151: * @param mode tree mode
152: * @return the content
153: * @throws FxApplicationException if the function fails
154: */
155: public String getContent(long id, FxTreeMode mode)
156: throws FxApplicationException;
157:
158: /**
159: * Retrives the final content from the template.
160: * <p/>
161: * The "final" content is the text that is use by the application server to generate the pages.
162: *
163: * @param id the template id
164: * @param mode tree mode
165: * @param masterTemplateFile The absolute filesystem name of the master template file
166: * @return the final content
167: * @throws FxApplicationException if the function fails
168: */
169: public String getFinalContent(long id, String masterTemplateFile,
170: FxTreeMode mode) throws FxApplicationException;
171:
172: /**
173: * Retrives the content from the template.
174: * <p/>
175: * This function returns the content represented to the users for editing, while the getFinalContent(id) function
176: * returns the text that is use by the application server to generate the pages.
177: *
178: * @param templateName the template name
179: * @param mode tree mode
180: * @return the final content
181: * @throws FxApplicationException if the function fails
182: */
183: public String getContent(String templateName, FxTreeMode mode)
184: throws FxApplicationException;
185:
186: /**
187: * Retrives the final content from the template.
188: * <p/>
189: * The "final" content is the text that is use by the application server to generate the pages.
190: *
191: * @param templateName the template name
192: * @param masterTemplateFile The absolute filesystem name of the master template file
193: * @return the final content
194: * @throws FxApplicationException if the function fails
195: */
196: public String getFinalContent(String templateName,
197: String masterTemplateFile) throws FxApplicationException;
198:
199: public ArrayList<FxTemplateMapping> getTemplateMappings(
200: long treeNodeId, FxTreeMode mode)
201: throws FxApplicationException;
202:
203: /**
204: * Gets the template for the specified node id.
205: *
206: * @param treeNodeId the tree node id to get the template for.
207: * @param mode tree mode
208: * @return the template infos
209: * @throws FxApplicationException if the function fails
210: */
211: public FxTemplateInfo getTemplate(long treeNodeId, FxTreeMode mode)
212: throws FxApplicationException;
213:
214: public void setTemplateMappings(long nodeId,
215: List<FxTemplateMapping> map) throws FxApplicationException;
216: }
|