001: package org.tigris.scarab.actions.base;
002:
003: /* ================================================================
004: * Copyright (c) 2000-2002 CollabNet. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are
008: * met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in the
015: * documentation and/or other materials provided with the distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowlegement: "This product includes
019: * software developed by Collab.Net <http://www.Collab.Net/>."
020: * Alternately, this acknowlegement may appear in the software itself, if
021: * and wherever such third-party acknowlegements normally appear.
022: *
023: * 4. The hosted project names must not be used to endorse or promote
024: * products derived from this software without prior written
025: * permission. For written permission, please contact info@collab.net.
026: *
027: * 5. Products derived from this software may not use the "Tigris" or
028: * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
029: * prior written permission of Collab.Net.
030: *
031: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
032: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
033: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
034: * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
035: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
036: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
037: * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
038: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
039: * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
040: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
041: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
042: *
043: * ====================================================================
044: *
045: * This software consists of voluntary contributions made by many
046: * individuals on behalf of Collab.Net.
047: */
048:
049: // Java Stuff
050: // Turbine Stuff
051: import org.apache.fulcrum.parser.ParameterParser;
052: import org.apache.log4j.Logger;
053: import org.apache.turbine.RunData;
054: import org.apache.turbine.TemplateAction;
055: import org.apache.turbine.TemplateContext;
056: import org.apache.turbine.tool.IntakeTool;
057: import org.tigris.scarab.tools.ScarabLocalizationTool;
058: import org.tigris.scarab.tools.ScarabRequestTool;
059: import org.tigris.scarab.util.ScarabConstants;
060:
061: /**
062: * This is a helper class that extends TemplateAction to add
063: * a couple methods useful for Scarab.
064: *
065: * @author <a href="mailto:jon@collab.net">Jon S. Stevens</a>
066: * @version $Id: ScarabTemplateAction.java 9255 2004-11-14 21:07:04Z dep4b $
067: */
068: public abstract class ScarabTemplateAction extends TemplateAction {
069: private static final Logger LOG = Logger
070: .getLogger("org.tigris.scarab");
071:
072: protected static final String ERROR_MESSAGE = "MoreInformationWasRequired";
073: protected static final String NO_PERMISSION_MESSAGE = "YouDoNotHavePermissionToAction";
074: protected static final String DEFAULT_MSG = "YourChangesWereSaved";
075: protected static final String EMAIL_ERROR = "CouldNotSendEmail";
076:
077: /**
078: * Helper method to retrieve the IntakeTool from the Context
079: */
080: public IntakeTool getIntakeTool(TemplateContext context) {
081: return (IntakeTool) getTool(context,
082: ScarabConstants.INTAKE_TOOL);
083: }
084:
085: /**
086: * Helper method to retrieve the ScarabRequestTool from the Context
087: */
088: public ScarabRequestTool getScarabRequestTool(
089: TemplateContext context) {
090: return (ScarabRequestTool) context
091: .get(ScarabConstants.SCARAB_REQUEST_TOOL);
092: }
093:
094: /**
095: * Helper method to retrieve the ScarabLocalizationTool from the Context
096: */
097: protected final ScarabLocalizationTool getLocalizationTool(
098: TemplateContext context) {
099: return (ScarabLocalizationTool) context
100: .get(ScarabConstants.LOCALIZATION_TOOL);
101: }
102:
103: /**
104: * Returns the current template that is being executed, otherwisse
105: * it returns null
106: */
107: public String getCurrentTemplate(RunData data) {
108: return data.getParameters().getString(ScarabConstants.TEMPLATE,
109: null);
110: }
111:
112: /**
113: * Returns the current template that is being executed, otherwisse
114: * it returns defaultValue.
115: */
116: public String getCurrentTemplate(RunData data, String defaultValue) {
117: return data.getParameters().getString(ScarabConstants.TEMPLATE,
118: defaultValue);
119: }
120:
121: /**
122: * Returns the nextTemplate to be executed. Otherwise returns null.
123: */
124: public String getNextTemplate(RunData data) {
125: return data.getParameters().getString(
126: ScarabConstants.NEXT_TEMPLATE, null);
127: }
128:
129: /**
130: * Returns the nextTemplate to be executed. Otherwise returns defaultValue.
131: */
132: public String getNextTemplate(RunData data, String defaultValue) {
133: return data.getParameters().getString(
134: ScarabConstants.NEXT_TEMPLATE, defaultValue);
135: }
136:
137: /**
138: * Returns the last template to be cancelled back to.
139: */
140: public String getLastTemplate(RunData data) {
141: return data.getParameters().getString(
142: ScarabConstants.LAST_TEMPLATE, null);
143: }
144:
145: /**
146: * Returns the cancelTemplate to be executed. Otherwise returns null.
147: */
148: public String getCancelTemplate(RunData data) {
149: return data.getParameters().getString(
150: ScarabConstants.CANCEL_TEMPLATE, null);
151: }
152:
153: /**
154: * Returns the cancelTemplate to be executed.
155: * Otherwise returns defaultValue.
156: */
157: public String getCancelTemplate(RunData data, String defaultValue) {
158: return data.getParameters().getString(
159: ScarabConstants.CANCEL_TEMPLATE, defaultValue);
160: }
161:
162: /**
163: * Returns the backTemplate to be executed. Otherwise returns null.
164: */
165: public String getBackTemplate(RunData data) {
166: return data.getParameters().getString(
167: ScarabConstants.BACK_TEMPLATE, null);
168: }
169:
170: /**
171: * Returns the backTemplate to be executed.
172: * Otherwise returns defaultValue.
173: */
174: public String getBackTemplate(RunData data, String defaultValue) {
175: return data.getParameters().getString(
176: ScarabConstants.BACK_TEMPLATE, defaultValue);
177: }
178:
179: /**
180: * Returns the other template that is being executed, otherwise
181: * it returns null.
182: */
183: public String getOtherTemplate(RunData data) {
184: return data.getParameters().getString(
185: ScarabConstants.OTHER_TEMPLATE);
186: }
187:
188: public void doSave(RunData data, TemplateContext context)
189: throws Exception {
190: }
191:
192: public void doGonext(RunData data, TemplateContext context)
193: throws Exception {
194: setTarget(data, getNextTemplate(data));
195: }
196:
197: public void doGotoothertemplate(RunData data,
198: TemplateContext context) throws Exception {
199: data.getParameters().setString(ScarabConstants.CANCEL_TEMPLATE,
200: getCurrentTemplate(data));
201: setTarget(data, getOtherTemplate(data));
202: }
203:
204: public void doRefresh(RunData data, TemplateContext context)
205: throws Exception {
206: setTarget(data, getCurrentTemplate(data));
207: }
208:
209: public void doReset(RunData data, TemplateContext context)
210: throws Exception {
211: IntakeTool intake = getIntakeTool(context);
212: intake.removeAll();
213: setTarget(data, getCurrentTemplate(data));
214: }
215:
216: public void doCancel(RunData data, TemplateContext context)
217: throws Exception {
218: setTarget(data, getCancelTemplate(data));
219: }
220:
221: public void doDone(RunData data, TemplateContext context)
222: throws Exception {
223: doSave(data, context);
224: doCancel(data, context);
225: }
226:
227: protected Logger log() {
228: return LOG;
229: }
230:
231: public void doRefreshresultsperpage(RunData data,
232: TemplateContext context) throws Exception {
233: ParameterParser params = data.getParameters();
234: int oldResultsPerPage = params.getInt("oldResultsPerPage");
235: int newResultsPerPage = params.getInt("resultsPerPage");
236: int oldPageNum = params.getInt("pageNum");
237:
238: //
239: // We want to display whichever page contains the first issue
240: // on the old page.
241: //
242: int firstItem = (oldPageNum - 1) * oldResultsPerPage + 1;
243: int newPageNum = (firstItem / newResultsPerPage) + 1;
244: params.remove("oldResultsPerPage");
245: params.remove("pageNum");
246: params.add("pageNum", newPageNum);
247: setTarget(data, getCurrentTemplate(data));
248: }
249: }
|