01: /*
02: * Copyright 2005 Sun Microsystems, Inc. All rights reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions
06: * are met:
07: *
08: * - Redistributions of source code must retain the above copyright
09: * notice, this list of conditions and the following disclaimer.
10: *
11: * - Redistribution in binary form must reproduce the above copyright
12: * notice, this list of conditions and the following disclaimer in
13: * the documentation and/or other materials provided with the
14: * distribution.
15: *
16: * Neither the name of Sun Microsystems, Inc. or the names of
17: * contributors may be used to endorse or promote products derived
18: * from this software without specific prior written permission.
19: *
20: * This software is provided "AS IS," without a warranty of any
21: * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND
22: * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
23: * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
24: * EXCLUDED. SUN AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES
25: * SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
26: * DISTRIBUTING THE SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN
27: * OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR
28: * FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR
29: * PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF
30: * LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE SOFTWARE,
31: * EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
32: *
33: * You acknowledge that Software is not designed, licensed or intended
34: * any nuclear facility.
35: */
36:
37: package com.sun.portal.community.template;
38:
39: import java.io.InputStream;
40:
41: import java.util.Set;
42: import java.util.Map;
43: import java.util.Locale;
44:
45: public interface Template {
46:
47: /**
48: * Get ID of the template.
49: *
50: * @return ID of the template
51: */
52: public String getId();
53:
54: /**
55: * Get roles used in the template.
56: *
57: * @return a set of roles used in the template
58: * @throws TemplateException
59: */
60: public Set getRoleTemplateNames() throws TemplateException;
61:
62: /**
63: * Get the template for the role provided.
64: * @param role role for which you want to get the template
65: * @return content of the role template
66: * @throws TemplateException
67: */
68: public byte[] getRoleTemplate(String role) throws TemplateException;;
69:
70: /**
71: * Get all templates.
72: *
73: * @return a map mapping the role to its corresponding template.
74: */
75: public Map getRoleTemplates();
76:
77: /**
78: * Get <code>String</code> representation of the template - Used for debugging.
79: *
80: * @return String representation of the template
81: */
82: public String toString();
83:
84: }
|