01: /*
02: * This file is part of the Echo Web Application Framework (hereinafter "Echo").
03: * Copyright (C) 2002-2005 NextApp, Inc.
04: *
05: * Version: MPL 1.1/GPL 2.0/LGPL 2.1
06: *
07: * The contents of this file are subject to the Mozilla Public License Version
08: * 1.1 (the "License"); you may not use this file except in compliance with
09: * the License. You may obtain a copy of the License at
10: * http://www.mozilla.org/MPL/
11: *
12: * Software distributed under the License is distributed on an "AS IS" basis,
13: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14: * for the specific language governing rights and limitations under the
15: * License.
16: *
17: * Alternatively, the contents of this file may be used under the terms of
18: * either the GNU General Public License Version 2 or later (the "GPL"), or
19: * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
20: * in which case the provisions of the GPL or the LGPL are applicable instead
21: * of those above. If you wish to allow use of your version of this file only
22: * under the terms of either the GPL or the LGPL, and not to allow others to
23: * use your version of this file under the terms of the MPL, indicate your
24: * decision by deleting the provisions above and replace them with the notice
25: * and other provisions required by the GPL or the LGPL. If you do not delete
26: * the provisions above, a recipient may use your version of this file under
27: * the terms of any one of the MPL, the GPL or the LGPL.
28: */
29:
30: package nextapp.echo2.app;
31:
32: /**
33: * Interface for objects which may be identified for rendering purposes via
34: * via unique String identifiers. Identifiers must be unique within a given
35: * <code>ApplicationInstance</code>.
36: * <p>If an object will only be associated
37: * with a single <code>ApplicationInstance</code>, the
38: * <code>ApplicationInstance.generateId()</code> method may be used to generate
39: * an application unique identifier.
40: * If an object may be associated with multiple
41: * <code>ApplicationInstance</code>s, the
42: * <code>ApplicationInstance.generateSystemId()</code> method should instead
43: * be used.
44: * <p>
45: * An identifier string may only letters, digits and underscores
46: * [A-Z,a-z,0-9,_]
47: */
48: public interface RenderIdSupport {
49:
50: /**
51: * Returns an identifier that is unique within the
52: * <code>ApplicationInstance</code> with which the implementor will be
53: * used.
54: */
55: public String getRenderId();
56: }
|