KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > core > filter > AbstractFilterAction


1 //The contents of this file are subject to the Mozilla Public License Version 1.1
2
//(the "License"); you may not use this file except in compliance with the
3
//License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
4
//
5
//Software distributed under the License is distributed on an "AS IS" basis,
6
//WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
7
//for the specific language governing rights and
8
//limitations under the License.
9
//
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 IExtensionInterface {
35     /**
36      *
37      * @param filterAction
38      * filterAction containing the filter actoin configuration
39      * @param srcFolder
40      * selected folder
41      * @param uids
42      * message UIDs
43      * @return return null for simple tasks, all other tasks have to implement
44      * their own {@link Command}
45      *
46      * @throws Exception
47      * exception is just passed to the upper-level
48      */

49     public abstract ICommand getCommand(IFilterAction filterAction,
50             IFolder srcFolder, Object JavaDoc[] uids) throws Exception JavaDoc;
51 }
Popular Tags