1 /*
2 * $Id: Subscription.java 471754 2006-11-06 14:55:09Z husted $
3 *
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22
23 package org.apache.struts.apps.mailreader.dao;
24
25
26 /**
27 * <p>A <strong>Subscription</strong> which is stored, along with the
28 * associated {@link User}, in a {@link UserDatabase}.</p>
29 *
30 * @version $Rev: 471754 $ $Date: 2006-11-06 08:55:09 -0600 (Mon, 06 Nov 2006) $
31 */
32
33 public interface Subscription {
34
35
36 // ------------------------------------------------------------- Properties
37
38
39 /**
40 * Return the auto-connect flag.
41 */
42 public boolean getAutoConnect();
43
44
45 /**
46 * Set the auto-connect flag.
47 *
48 * @param autoConnect The new auto-connect flag
49 */
50 public void setAutoConnect(boolean autoConnect);
51
52
53 /**
54 * Return the host name.
55 */
56 public String getHost();
57
58
59 /**
60 * Return the password.
61 */
62 public String getPassword();
63
64
65 /**
66 * Set the password.
67 *
68 * @param password The new password
69 */
70 public void setPassword(String password);
71
72
73 /**
74 * Return the subscription type.
75 */
76 public String getType();
77
78
79 /**
80 * Set the subscription type.
81 *
82 * @param type The new subscription type
83 */
84 public void setType(String type);
85
86
87 /**
88 * Return the {@link User} owning this Subscription.
89 */
90 public User getUser();
91
92
93 /**
94 * Return the username.
95 */
96 public String getUsername();
97
98
99 /**
100 * Set the username.
101 *
102 * @param username The new username
103 */
104 public void setUsername(String username);
105
106
107 }