ConversationParameters


1   /*
2    * Copyright 2002-2006 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
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, String   description) {
52          this.name = name;
53          this.caption = caption;
54          this.description = description;
55      }
56  
57      /**
58       * Returns the name of the conversation.
59       * @return the conversation name
60       */
61      public String   getName() {
62          return name;
63      }
64  
65      /**
66       * Returns the short description.
67       * @return the conversation caption
68       */
69      public String   getCaption() {
70          return caption;
71      }
72  
73      /**
74       * Returns the long description.
75       * @return the description.
76       */
77      public String   getDescription() {
78          return description;
79      }
80      
81      public String   toString() {
82          return new ToStringCreator(this).append("name", name).toString();
83      }
84  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags