summaryrefslogtreecommitdiffstats
path: root/proxy/src/main/java/org/fedoraproject/candlepin/model/Product.java
blob: 1ff6e1d311ee0397b25d7adf22e7077738f9f883 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/**
 * Copyright (c) 2009 Red Hat, Inc.
 *
 * This software is licensed to you under the GNU General Public License,
 * version 2 (GPLv2). There is NO WARRANTY for this software, express or
 * implied, including the implied warranties of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. You should have received a copy of GPLv2
 * along with this software; if not, see
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
 *
 * Red Hat trademarks are not licensed under GPLv2. No permission is
 * granted to use or replicate Red Hat trademarks that are incorporated
 * in this software or its documentation.
 */
package org.fedoraproject.candlepin.model;

import java.util.LinkedList;
import java.util.List;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
import javax.persistence.Transient;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;

/**
 * Represents a Product that can be consumed and entitled. Products define
 * the software or entity they want to entitle i.e. RHEL Server. They also 
 * contain descriptive meta data that might limit the Product i.e. 4 cores
 * per server with 4 guests. 
 */
@XmlRootElement
@XmlAccessorType(XmlAccessType.PROPERTY)
@Entity
@Table(name="cp_product")
public class Product {

    private Long id;
    
    // TODO: Drop one of these?
    private String label;
    private String name;
    
    // TODO: Drop this?
    private String uuid;
    
    // TODO:
    private List<Product> childProducts;

    /**
     * Create product with UUID
     * @param uuid unique id for the product
     */
    public Product(String uuid) {
        setUuid(uuid);
    }
    
    /**
     * Constructor
     * 
     * Use this variant when creating a new object to persist.
     * 
     * @param label
     * @param name
     */
    public Product(String label, String name) {
        // TODO: Do we want to drop one of these?
        setLabel(label);
        setName(name);
    }

    /**
     * Default constructor
     */
    public Product() {
    }

    /**
     * @return the id
     */
    @Id
    @GeneratedValue(strategy=GenerationType.AUTO)
    public Long getId() {
        return id;
    }

    /**
     * @param id the id to set
     */
    public void setId(Long id) {
        this.id = id;
    }

    /**
     * @return the childProducts
     */
    @Transient
    public List<Product> getChildProducts() {
        return childProducts;
    }

    /**
     * @param childProducts the childProducts to set
     */
    public void setChildProducts(List<Product> childProducts) {
        this.childProducts = childProducts;
    }

    /**
     * Add a child of this Product.
     * @param p to add
     */
    public void addChildProduct(Product p) {
        if (this.childProducts == null) {
            this.childProducts = new LinkedList<Product>();
        }
        this.childProducts.add(p);
    }
    
//    /** 
//     * Get the list of compatible consumer types
//     * @return list of compatible consumer types
//     */
//    public List<String> getCompatibleConsumerTypes() {
//        
//        return null;
//    }

    
    /**
     * @return Returns the label.
     */
    @Column(nullable=false)
    public String getLabel() {
        return label;
    }

    
    /**
     * @param labelIn The label to set.
     */
    public void setLabel(String labelIn) {
        label = labelIn;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        return "Product [label=" + label + "]";
    }
    
    /**
     * Returns the name of the object.
     * @return the name of the object.
     */
    @Column(nullable=false)
    public String getName() {
        return name;
    }

    /**
     * Set the name of the model object.
     * @param name name of the object
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * Returns the unique id of the model object.
     * @return the unique id of the model object.
     */
    public String getUuid() {
        return uuid;
    }

    /**
     * Sets the unique id of the model object.
     * @param uuid unique id of the model.
     */
    public void setUuid(String uuid) {
        this.uuid = uuid;
    }

}