KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > ofbiz > minilang > method > entityops > RemoveList


1 /*
2  * $Id: RemoveList.java 5462 2005-08-05 18:35:48Z jonesde $
3  *
4  * Copyright (c) 2001-2005 The Open For Business Project - www.ofbiz.org
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included
14  * in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
21  * OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 package org.ofbiz.minilang.method.entityops;
25
26 import java.util.List JavaDoc;
27
28 import org.ofbiz.base.util.Debug;
29 import org.ofbiz.entity.GenericEntityException;
30 import org.ofbiz.minilang.SimpleMethod;
31 import org.ofbiz.minilang.method.ContextAccessor;
32 import org.ofbiz.minilang.method.MethodContext;
33 import org.ofbiz.minilang.method.MethodOperation;
34 import org.w3c.dom.Element JavaDoc;
35
36 /**
37  * Uses the delegator to remove the specified value object (or psuedo-pk) list from the datasource
38  *
39  * @author <a HREF="mailto:jonesde@ofbiz.org">David E. Jones</a>
40  * @version $Rev: 5462 $
41  * @since 2.0
42  */
43 public class RemoveList extends MethodOperation {
44     
45     public static final String JavaDoc module = RemoveList.class.getName();
46
47     ContextAccessor listAcsr;
48     String JavaDoc doCacheClearStr;
49
50     public RemoveList(Element JavaDoc element, SimpleMethod simpleMethod) {
51         super(element, simpleMethod);
52         listAcsr = new ContextAccessor(element.getAttribute("list-name"));
53         doCacheClearStr = element.getAttribute("do-cache-clear");
54     }
55
56     public boolean exec(MethodContext methodContext) {
57         boolean doCacheClear = !"false".equals(doCacheClearStr);
58         
59         List JavaDoc values = (List JavaDoc) listAcsr.get(methodContext);
60         if (values == null) {
61             String JavaDoc errMsg = "In remove-list a value list was not found with the specified listAcsr: " + listAcsr + ", not removing";
62
63             Debug.logWarning(errMsg, module);
64             if (methodContext.getMethodType() == MethodContext.EVENT) {
65                 methodContext.putEnv(simpleMethod.getEventErrorMessageName(), errMsg);
66                 methodContext.putEnv(simpleMethod.getEventResponseCodeName(), simpleMethod.getDefaultErrorCode());
67             } else if (methodContext.getMethodType() == MethodContext.SERVICE) {
68                 methodContext.putEnv(simpleMethod.getServiceErrorMessageName(), errMsg);
69                 methodContext.putEnv(simpleMethod.getServiceResponseMessageName(), simpleMethod.getDefaultErrorCode());
70             }
71             return false;
72         }
73
74         try {
75             methodContext.getDelegator().removeAll(values, doCacheClear);
76         } catch (GenericEntityException e) {
77             Debug.logError(e, module);
78             String JavaDoc errMsg = "ERROR: Could not complete the " + simpleMethod.getShortDescription() + " process [problem removing the " + listAcsr + " value list: " + e.getMessage() + "]";
79
80             if (methodContext.getMethodType() == MethodContext.EVENT) {
81                 methodContext.putEnv(simpleMethod.getEventErrorMessageName(), errMsg);
82                 methodContext.putEnv(simpleMethod.getEventResponseCodeName(), simpleMethod.getDefaultErrorCode());
83             } else if (methodContext.getMethodType() == MethodContext.SERVICE) {
84                 methodContext.putEnv(simpleMethod.getServiceErrorMessageName(), errMsg);
85                 methodContext.putEnv(simpleMethod.getServiceResponseMessageName(), simpleMethod.getDefaultErrorCode());
86             }
87             return false;
88         }
89         return true;
90     }
91
92     public String JavaDoc rawString() {
93         // TODO: something more than the empty tag
94 return "<remove-list/>";
95     }
96     public String JavaDoc expandedString(MethodContext methodContext) {
97         // TODO: something more than a stub/dummy
98 return this.rawString();
99     }
100 }
101
Popular Tags