View Javadoc

1   /**
2    * Copyright 2005-2006 the original author or authors.
3    *
4    * Licensed under the Gnu General Pubic License, Version 2.0 (the
5    * "License"); you may not use this file except in compliance with
6    * the License. You may obtain a copy of the License at
7    *
8    *      http://www.opensource.org/licenses/gpl-license.php
9    *
10   * This program is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13   * See the Gnu General Public License for more details.
14   */
15  package org.figure8.join.businessobjects.environment;
16  
17  import org.figure8.join.core.EntityObject;
18  /**
19   * This is an entity representing a parameter used for configuring physical
20   * environment. Such parameters can be used to specify deployment parameters
21   * of the software project to integrate.
22   * @author <a href="mailto:jerome.evrard@gmail.com">Jerome Evrard</a>
23   * @version $Revision: 1.2 $
24   *
25   * @hibernate.class table="join_parameters"
26   * @hibernate.cache usage="read-write"
27   *
28   * @hibernate.query name="join.parameter_findByName" query="from Parameter param where param.name = :parameterName"
29   */
30  public class Parameter extends EntityObject{
31  
32     // Attributes ---------------------------------------------------------------
33     
34     /** The parameter name */
35     private String name;
36     /** The parameter description */
37     private String description;
38  
39  
40     // Constructors -------------------------------------------------------------
41     
42     /** Creates a new instance of Parameter */
43     public Parameter(){
44     }
45     
46     /**
47      * Creates a new instance of Parameter with mandatory attributes.
48      * @param name The parameter name.
49      * @param description The parameter description.
50      */
51     public Parameter(String name, String description){
52        this.name = name;
53        this.description = description;
54     }
55  
56  
57     // Public -------------------------------------------------------------------
58     
59     /**
60      * Get the parameter name
61      * @hibernate.property column="s_name"
62      *    not-null="true" unique="true"
63      *    length="80"
64      * @return The parameter name
65      */
66     public String getName(){
67        return name;
68     }
69     /**
70      * Set the parameter name
71      * @param name The parameter name to set.
72      */
73     public void setName(String name){
74        this.name = name;
75     }
76     
77     /**
78      * Get the parameter description
79      * @hibernate.property column="s_description" length="200"    
80      * @return The parameter description
81      */
82     public String getDescription(){
83        return description;
84     }
85     /**
86      * Set the parameter description
87      * @param description The parameter description to set.
88      */
89     public void setDescription(String description){
90        this.description = description;
91     }
92  }