1 /*
2 * $Id$
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 * @author Craig R. McClanahan
31 * @version $Rev$ $Date$
32 */
33
34 public interface Subscription {
35
36
37 // ------------------------------------------------------------- Properties
38
39
40 /**
41 * Return the auto-connect flag.
42 */
43 public boolean getAutoConnect();
44
45
46 /**
47 * Set the auto-connect flag.
48 *
49 * @param autoConnect The new auto-connect flag
50 */
51 public void setAutoConnect(boolean autoConnect);
52
53
54 /**
55 * Return the host name.
56 */
57 public String getHost();
58
59
60 /**
61 * Return the password.
62 */
63 public String getPassword();
64
65
66 /**
67 * Set the password.
68 *
69 * @param password The new password
70 */
71 public void setPassword(String password);
72
73
74 /**
75 * Return the subscription type.
76 */
77 public String getType();
78
79
80 /**
81 * Set the subscription type.
82 *
83 * @param type The new subscription type
84 */
85 public void setType(String type);
86
87
88 /**
89 * Return the {@link User} owning this Subscription.
90 */
91 public User getUser();
92
93
94 /**
95 * Return the username.
96 */
97 public String getUsername();
98
99
100 /**
101 * Set the username.
102 *
103 * @param username The new username
104 */
105 public void setUsername(String username);
106
107
108 }