01: /*
02: * $Id: Subscription.java 471754 2006-11-06 14:55:09Z husted $
03: *
04: * Licensed to the Apache Software Foundation (ASF) under one
05: * or more contributor license agreements. See the NOTICE file
06: * distributed with this work for additional information
07: * regarding copyright ownership. The ASF licenses this file
08: * to you under the Apache License, Version 2.0 (the
09: * "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: package org.apache.struts.apps.mailreader.dao;
23:
24: /**
25: * <p>A <strong>Subscription</strong> which is stored, along with the
26: * associated {@link User}, in a {@link UserDatabase}.</p>
27: *
28: * @version $Rev: 471754 $ $Date: 2006-11-06 08:55:09 -0600 (Mon, 06 Nov 2006) $
29: */
30:
31: public interface Subscription {
32:
33: // ------------------------------------------------------------- Properties
34:
35: /**
36: * Return the auto-connect flag.
37: */
38: public boolean getAutoConnect();
39:
40: /**
41: * Set the auto-connect flag.
42: *
43: * @param autoConnect The new auto-connect flag
44: */
45: public void setAutoConnect(boolean autoConnect);
46:
47: /**
48: * Return the host name.
49: */
50: public String getHost();
51:
52: /**
53: * Return the password.
54: */
55: public String getPassword();
56:
57: /**
58: * Set the password.
59: *
60: * @param password The new password
61: */
62: public void setPassword(String password);
63:
64: /**
65: * Return the subscription type.
66: */
67: public String getType();
68:
69: /**
70: * Set the subscription type.
71: *
72: * @param type The new subscription type
73: */
74: public void setType(String type);
75:
76: /**
77: * Return the {@link User} owning this Subscription.
78: */
79: public User getUser();
80:
81: /**
82: * Return the username.
83: */
84: public String getUsername();
85:
86: /**
87: * Set the username.
88: *
89: * @param username The new username
90: */
91: public void setUsername(String username);
92:
93: }
|