001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016// Generated File -- DO NOT EDIT BY HAND
017// --------------------------------------------------------------------------------
018
019/**
020 * RatingDetail.java
021 */
022
023package com.echothree.model.data.rating.server.entity;
024
025import com.echothree.model.data.rating.common.pk.RatingDetailPK;
026
027import com.echothree.model.data.rating.common.pk.RatingPK;
028import com.echothree.model.data.rating.common.pk.RatingTypeListItemPK;
029import com.echothree.model.data.core.common.pk.EntityInstancePK;
030
031import com.echothree.model.data.rating.server.entity.Rating;
032import com.echothree.model.data.rating.server.entity.RatingTypeListItem;
033import com.echothree.model.data.core.server.entity.EntityInstance;
034
035import com.echothree.model.data.rating.server.factory.RatingFactory;
036import com.echothree.model.data.rating.server.factory.RatingTypeListItemFactory;
037import com.echothree.model.data.core.server.factory.EntityInstanceFactory;
038
039import com.echothree.model.data.rating.common.pk.RatingDetailPK;
040
041import com.echothree.model.data.rating.server.value.RatingDetailValue;
042
043import com.echothree.model.data.rating.server.factory.RatingDetailFactory;
044
045import com.echothree.util.common.exception.PersistenceException;
046import com.echothree.util.common.exception.PersistenceDatabaseException;
047import com.echothree.util.common.exception.PersistenceNotNullException;
048import com.echothree.util.common.exception.PersistenceReadOnlyException;
049
050import com.echothree.util.common.persistence.BasePK;
051
052import com.echothree.util.common.persistence.type.ByteArray;
053
054import com.echothree.util.server.persistence.BaseEntity;
055import com.echothree.util.server.persistence.EntityPermission;
056import com.echothree.util.server.persistence.Session;
057import com.echothree.util.server.persistence.ThreadSession;
058
059import java.io.Serializable;
060
061public class RatingDetail
062        extends BaseEntity
063        implements Serializable {
064    
065    private RatingDetailPK _pk;
066    private RatingDetailValue _value;
067    
068    /** Creates a new instance of RatingDetail */
069    public RatingDetail()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of RatingDetail */
075    public RatingDetail(RatingDetailValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public RatingDetailFactory getBaseFactoryInstance() {
084        return RatingDetailFactory.getInstance();
085    }
086    
087    @Override
088    public boolean hasBeenModified() {
089        return _value.hasBeenModified();
090    }
091    
092    @Override
093    public int hashCode() {
094        return _pk.hashCode();
095    }
096    
097    @Override
098    public String toString() {
099        return _pk.toString();
100    }
101    
102    @Override
103    public boolean equals(Object other) {
104        if(this == other)
105            return true;
106        
107        if(other instanceof RatingDetail that) {
108            RatingDetailValue thatValue = that.getRatingDetailValue();
109            return _value.equals(thatValue);
110        } else {
111            return false;
112        }
113    }
114    
115    @Override
116    public void store()
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().store(this);
119    }
120    
121    @Override
122    public void remove()
123            throws PersistenceDatabaseException {
124        getBaseFactoryInstance().remove(this);
125    }
126    
127    public RatingDetailValue getRatingDetailValue() {
128        return _value;
129    }
130    
131    public void setRatingDetailValue(RatingDetailValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    public RatingDetailPK getPrimaryKey() {
139        return _pk;
140    }
141    
142    public RatingPK getRatingPK() {
143        return _value.getRatingPK();
144    }
145    
146    public Rating getRating(EntityPermission entityPermission) {
147        return RatingFactory.getInstance().getEntityFromPK(entityPermission, getRatingPK());
148    }
149    
150    public Rating getRating() {
151        return getRating(EntityPermission.READ_ONLY);
152    }
153    
154    public Rating getRatingForUpdate() {
155        return getRating(EntityPermission.READ_WRITE);
156    }
157    
158    public void setRatingPK(RatingPK ratingPK)
159            throws PersistenceNotNullException, PersistenceReadOnlyException {
160        checkReadWrite();
161        _value.setRatingPK(ratingPK);
162    }
163    
164    public void setRating(Rating entity) {
165        setRatingPK(entity == null? null: entity.getPrimaryKey());
166    }
167    
168    public boolean getRatingPKHasBeenModified() {
169        return _value.getRatingPKHasBeenModified();
170    }
171    
172    public String getRatingName() {
173        return _value.getRatingName();
174    }
175    
176    public void setRatingName(String ratingName)
177            throws PersistenceNotNullException, PersistenceReadOnlyException {
178        checkReadWrite();
179        _value.setRatingName(ratingName);
180    }
181    
182    public boolean getRatingNameHasBeenModified() {
183        return _value.getRatingNameHasBeenModified();
184    }
185    
186    public RatingTypeListItemPK getRatingTypeListItemPK() {
187        return _value.getRatingTypeListItemPK();
188    }
189    
190    public RatingTypeListItem getRatingTypeListItem(EntityPermission entityPermission) {
191        return RatingTypeListItemFactory.getInstance().getEntityFromPK(entityPermission, getRatingTypeListItemPK());
192    }
193    
194    public RatingTypeListItem getRatingTypeListItem() {
195        return getRatingTypeListItem(EntityPermission.READ_ONLY);
196    }
197    
198    public RatingTypeListItem getRatingTypeListItemForUpdate() {
199        return getRatingTypeListItem(EntityPermission.READ_WRITE);
200    }
201    
202    public void setRatingTypeListItemPK(RatingTypeListItemPK ratingTypeListItemPK)
203            throws PersistenceNotNullException, PersistenceReadOnlyException {
204        checkReadWrite();
205        _value.setRatingTypeListItemPK(ratingTypeListItemPK);
206    }
207    
208    public void setRatingTypeListItem(RatingTypeListItem entity) {
209        setRatingTypeListItemPK(entity == null? null: entity.getPrimaryKey());
210    }
211    
212    public boolean getRatingTypeListItemPKHasBeenModified() {
213        return _value.getRatingTypeListItemPKHasBeenModified();
214    }
215    
216    public EntityInstancePK getRatedEntityInstancePK() {
217        return _value.getRatedEntityInstancePK();
218    }
219    
220    public EntityInstance getRatedEntityInstance(EntityPermission entityPermission) {
221        return EntityInstanceFactory.getInstance().getEntityFromPK(entityPermission, getRatedEntityInstancePK());
222    }
223    
224    public EntityInstance getRatedEntityInstance() {
225        return getRatedEntityInstance(EntityPermission.READ_ONLY);
226    }
227    
228    public EntityInstance getRatedEntityInstanceForUpdate() {
229        return getRatedEntityInstance(EntityPermission.READ_WRITE);
230    }
231    
232    public void setRatedEntityInstancePK(EntityInstancePK ratedEntityInstancePK)
233            throws PersistenceNotNullException, PersistenceReadOnlyException {
234        checkReadWrite();
235        _value.setRatedEntityInstancePK(ratedEntityInstancePK);
236    }
237    
238    public void setRatedEntityInstance(EntityInstance entity) {
239        setRatedEntityInstancePK(entity == null? null: entity.getPrimaryKey());
240    }
241    
242    public boolean getRatedEntityInstancePKHasBeenModified() {
243        return _value.getRatedEntityInstancePKHasBeenModified();
244    }
245    
246    public EntityInstancePK getRatedByEntityInstancePK() {
247        return _value.getRatedByEntityInstancePK();
248    }
249    
250    public EntityInstance getRatedByEntityInstance(EntityPermission entityPermission) {
251        return EntityInstanceFactory.getInstance().getEntityFromPK(entityPermission, getRatedByEntityInstancePK());
252    }
253    
254    public EntityInstance getRatedByEntityInstance() {
255        return getRatedByEntityInstance(EntityPermission.READ_ONLY);
256    }
257    
258    public EntityInstance getRatedByEntityInstanceForUpdate() {
259        return getRatedByEntityInstance(EntityPermission.READ_WRITE);
260    }
261    
262    public void setRatedByEntityInstancePK(EntityInstancePK ratedByEntityInstancePK)
263            throws PersistenceNotNullException, PersistenceReadOnlyException {
264        checkReadWrite();
265        _value.setRatedByEntityInstancePK(ratedByEntityInstancePK);
266    }
267    
268    public void setRatedByEntityInstance(EntityInstance entity) {
269        setRatedByEntityInstancePK(entity == null? null: entity.getPrimaryKey());
270    }
271    
272    public boolean getRatedByEntityInstancePKHasBeenModified() {
273        return _value.getRatedByEntityInstancePKHasBeenModified();
274    }
275    
276    public Long getFromTime() {
277        return _value.getFromTime();
278    }
279    
280    public void setFromTime(Long fromTime)
281            throws PersistenceNotNullException, PersistenceReadOnlyException {
282        checkReadWrite();
283        _value.setFromTime(fromTime);
284    }
285    
286    public boolean getFromTimeHasBeenModified() {
287        return _value.getFromTimeHasBeenModified();
288    }
289    
290    public Long getThruTime() {
291        return _value.getThruTime();
292    }
293    
294    public void setThruTime(Long thruTime)
295            throws PersistenceNotNullException, PersistenceReadOnlyException {
296        checkReadWrite();
297        _value.setThruTime(thruTime);
298    }
299    
300    public boolean getThruTimeHasBeenModified() {
301        return _value.getThruTimeHasBeenModified();
302    }
303    
304}