01: //The contents of this file are subject to the Mozilla Public License Version 1.1
02: //(the "License"); you may not use this file except in compliance with the
03: //License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
04: //
05: //Software distributed under the License is distributed on an "AS IS" basis,
06: //WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
07: //for the specific language governing rights and
08: //limitations under the License.
09: //
10: //The Original Code is "The Columba Project"
11: //
12: //The Initial Developers of the Original Code are Frederik Dietz and Timo Stich.
13: //Portions created by Frederik Dietz and Timo Stich are Copyright (C) 2003.
14: //
15: //All Rights Reserved.
16: package org.columba.core.filter;
17:
18: import org.columba.api.command.ICommand;
19: import org.columba.api.plugin.IExtensionInterface;
20: import org.columba.core.command.Command;
21: import org.columba.core.folder.api.IFolder;
22:
23: /**
24: * Action which is executed if a filter found a matching set of messages.
25: * <p>
26: * If you need to run time consuming tasks which should be running in the
27: * background you need to create your own Command-Object. You should take a
28: * closer look to the Columba sourcetree. You will find dozens examples of
29: * Command- Objects which implement things like "Reply to Message", "Open
30: * Message in Composer", etc.
31: *
32: * @author fdietz
33: */
34: public abstract class AbstractFilterAction implements
35: IExtensionInterface {
36: /**
37: *
38: * @param filterAction
39: * filterAction containing the filter actoin configuration
40: * @param srcFolder
41: * selected folder
42: * @param uids
43: * message UIDs
44: * @return return null for simple tasks, all other tasks have to implement
45: * their own {@link Command}
46: *
47: * @throws Exception
48: * exception is just passed to the upper-level
49: */
50: public abstract ICommand getCommand(IFilterAction filterAction,
51: IFolder srcFolder, Object[] uids) throws Exception;
52: }
|