01: /*
02: * Copyright 2004-2007 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: package org.springframework.webflow.conversation;
17:
18: import java.io.Serializable;
19:
20: import org.springframework.core.style.ToStringCreator;
21:
22: /**
23: * Simple parameter object for clumping together input needed to begin a new
24: * conversation.
25: *
26: * @author Keith Donald
27: */
28: public class ConversationParameters implements Serializable {
29:
30: /**
31: * The conversation name.
32: */
33: private String name;
34:
35: /**
36: * The conversation caption.
37: */
38: private String caption;
39:
40: /**
41: * The conversation description.
42: */
43: private String description;
44:
45: /**
46: * Creates new conversation input parameters.
47: * @param name the name of the conversation
48: * @param caption a short description
49: * @param description a long description
50: */
51: public ConversationParameters(String name, String caption,
52: String description) {
53: this .name = name;
54: this .caption = caption;
55: this .description = description;
56: }
57:
58: /**
59: * Returns the name of the conversation.
60: * @return the conversation name
61: */
62: public String getName() {
63: return name;
64: }
65:
66: /**
67: * Returns the short description.
68: * @return the conversation caption
69: */
70: public String getCaption() {
71: return caption;
72: }
73:
74: /**
75: * Returns the long description.
76: * @return the description.
77: */
78: public String getDescription() {
79: return description;
80: }
81:
82: public String toString() {
83: return new ToStringCreator(this ).append("name", name)
84: .toString();
85: }
86: }
|