01: /*
02: * This file is part of PFIXCORE.
03: *
04: * PFIXCORE is free software; you can redistribute it and/or modify
05: * it under the terms of the GNU Lesser General Public License as published by
06: * the Free Software Foundation; either version 2 of the License, or
07: * (at your option) any later version.
08: *
09: * PFIXCORE is distributed in the hope that it will be useful,
10: * but WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12: * GNU Lesser General Public License for more details.
13: *
14: * You should have received a copy of the GNU Lesser General Public License
15: * along with PFIXCORE; if not, write to the Free Software
16: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17: */
18:
19: package de.schlund.pfixxml.config;
20:
21: import de.schlund.pfixcore.generator.IWrapper;
22:
23: /**
24: * Provides configuration for {@link de.schlund.pfixcore.generator.IWrapper} instances.
25: *
26: * @author Sebastian Marsching <sebastian.marsching@1und1.de>
27: */
28: public interface IWrapperConfig {
29:
30: /**
31: * Returns the prefix that is used for request parameters associated with
32: * this wrapper instance.
33: *
34: * @return prefix for request parameters
35: */
36: String getPrefix();
37:
38: /**
39: * Returns the class that shall be used for instances of the wrapper.
40: *
41: * @return wrapper class
42: */
43: Class<? extends IWrapper> getWrapperClass();
44:
45: /**
46: * Specifies whether the next page in the current pageflow should be triggered
47: * when a sumit to this specific wrapper is triggered.
48: *
49: * @return continue flag
50: */
51: boolean isContinue();
52:
53: /**
54: * If <code>true</code> the state will not check whether the correspondings
55: * handler isActive() method returns true when checking whether a page is
56: * accessible.
57: *
58: * @return flag indicating handling of active state
59: */
60: boolean isActiveIgnore();
61:
62: /**
63: * If <code>true</code> the <code>retrieveCurrentStatus()</code> method
64: * should always be called on the corresponding IHandler.
65: *
66: * @return flag indicating retrieveCurrentStatus() handling
67: */
68: boolean isAlwaysRetrieve();
69:
70: /**
71: * If <code>true</code> the IWrapper should enable logging.
72: *
73: * @return flag indicating whether to enable logging
74: */
75: boolean getLogging();
76:
77: }
|