01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: *
17: */
18:
19: /* $Id: TaskWrapper.java 473861 2006-11-12 03:51:14Z gregor $ */
20:
21: package org.apache.lenya.cms.task;
22:
23: import java.util.Map;
24:
25: import org.apache.lenya.xml.NamespaceHelper;
26: import org.w3c.dom.Element;
27:
28: /**
29: * A TaskWrapper encapsulates all information that is needed to execute a certain task, including
30: * e.g. workflow and notification parameters.
31: * @deprecated Use the usecase framework instead.
32: */
33: public interface TaskWrapper {
34:
35: /**
36: * Executes the task.
37: * @throws ExecutionException when something went wrong.
38: */
39: void execute() throws ExecutionException;
40:
41: /**
42: * Saves the wrapper parameters to an XML element.
43: * @param helper The namespace helper of the document.
44: * @return An XML element.
45: */
46: Element save(NamespaceHelper helper);
47:
48: /**
49: * @param helper The namespace helper of the document. Restores the wrapper parameters from an
50: * XML element.
51: * @param element An XML element.
52: */
53: void restore(NamespaceHelper helper, Element element);
54:
55: /**
56: * Returns the task wrapper parameters.
57: * @return A map.
58: */
59: Map getParameters();
60:
61: }
|