1   /**
2    * Copyright (c) 2000-2007 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portlet.mail.util.recipient;
24  
25  import java.util.Map;
26  import java.util.SortedSet;
27  
28  import javax.mail.internet.InternetAddress;
29  
30  import org.apache.commons.collections.map.MultiValueMap;
31  
32  /**
33   * <a href="RecipientFinder.java.html"><b><i>View Source</i></b></a>
34   *
35   * <p>
36   * Used to support the search for valid recipients for the mail portlet.
37   * </p>
38   *
39   * @author Alexander Chow
40   *
41   */
42  public interface RecipientFinder {
43  
44      public String getName();
45  
46      public MultiValueMap getOptions(long userId);
47  
48      public SortedSet getRecipients(long userId, String data, Map options);
49  
50      public boolean isReadOnly(long userId);
51  
52      public void save(long userId, InternetAddress ia)
53          throws UnsupportedOperationException;
54  
55  }