001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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) {
108            RatingDetail that = (RatingDetail)other;
109            
110            RatingDetailValue thatValue = that.getRatingDetailValue();
111            return _value.equals(thatValue);
112        } else {
113            return false;
114        }
115    }
116    
117    @Override
118    public void store(Session session)
119            throws PersistenceDatabaseException {
120        getBaseFactoryInstance().store(session, this);
121    }
122    
123    @Override
124    public void remove(Session session)
125            throws PersistenceDatabaseException {
126        getBaseFactoryInstance().remove(session, this);
127    }
128    
129    @Override
130    public void remove()
131            throws PersistenceDatabaseException {
132        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
133    }
134    
135    public RatingDetailValue getRatingDetailValue() {
136        return _value;
137    }
138    
139    public void setRatingDetailValue(RatingDetailValue value)
140            throws PersistenceReadOnlyException {
141        checkReadWrite();
142        _value = value;
143    }
144    
145    @Override
146    public RatingDetailPK getPrimaryKey() {
147        return _pk;
148    }
149    
150    public RatingPK getRatingPK() {
151        return _value.getRatingPK();
152    }
153    
154    public Rating getRating(Session session, EntityPermission entityPermission) {
155        return RatingFactory.getInstance().getEntityFromPK(session, entityPermission, getRatingPK());
156    }
157    
158    public Rating getRating(EntityPermission entityPermission) {
159        return getRating(ThreadSession.currentSession(), entityPermission);
160    }
161    
162    public Rating getRating(Session session) {
163        return getRating(session, EntityPermission.READ_ONLY);
164    }
165    
166    public Rating getRating() {
167        return getRating(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
168    }
169    
170    public Rating getRatingForUpdate(Session session) {
171        return getRating(session, EntityPermission.READ_WRITE);
172    }
173    
174    public Rating getRatingForUpdate() {
175        return getRating(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
176    }
177    
178    public void setRatingPK(RatingPK ratingPK)
179            throws PersistenceNotNullException, PersistenceReadOnlyException {
180        checkReadWrite();
181        _value.setRatingPK(ratingPK);
182    }
183    
184    public void setRating(Rating entity) {
185        setRatingPK(entity == null? null: entity.getPrimaryKey());
186    }
187    
188    public boolean getRatingPKHasBeenModified() {
189        return _value.getRatingPKHasBeenModified();
190    }
191    
192    public String getRatingName() {
193        return _value.getRatingName();
194    }
195    
196    public void setRatingName(String ratingName)
197            throws PersistenceNotNullException, PersistenceReadOnlyException {
198        checkReadWrite();
199        _value.setRatingName(ratingName);
200    }
201    
202    public boolean getRatingNameHasBeenModified() {
203        return _value.getRatingNameHasBeenModified();
204    }
205    
206    public RatingTypeListItemPK getRatingTypeListItemPK() {
207        return _value.getRatingTypeListItemPK();
208    }
209    
210    public RatingTypeListItem getRatingTypeListItem(Session session, EntityPermission entityPermission) {
211        return RatingTypeListItemFactory.getInstance().getEntityFromPK(session, entityPermission, getRatingTypeListItemPK());
212    }
213    
214    public RatingTypeListItem getRatingTypeListItem(EntityPermission entityPermission) {
215        return getRatingTypeListItem(ThreadSession.currentSession(), entityPermission);
216    }
217    
218    public RatingTypeListItem getRatingTypeListItem(Session session) {
219        return getRatingTypeListItem(session, EntityPermission.READ_ONLY);
220    }
221    
222    public RatingTypeListItem getRatingTypeListItem() {
223        return getRatingTypeListItem(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
224    }
225    
226    public RatingTypeListItem getRatingTypeListItemForUpdate(Session session) {
227        return getRatingTypeListItem(session, EntityPermission.READ_WRITE);
228    }
229    
230    public RatingTypeListItem getRatingTypeListItemForUpdate() {
231        return getRatingTypeListItem(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
232    }
233    
234    public void setRatingTypeListItemPK(RatingTypeListItemPK ratingTypeListItemPK)
235            throws PersistenceNotNullException, PersistenceReadOnlyException {
236        checkReadWrite();
237        _value.setRatingTypeListItemPK(ratingTypeListItemPK);
238    }
239    
240    public void setRatingTypeListItem(RatingTypeListItem entity) {
241        setRatingTypeListItemPK(entity == null? null: entity.getPrimaryKey());
242    }
243    
244    public boolean getRatingTypeListItemPKHasBeenModified() {
245        return _value.getRatingTypeListItemPKHasBeenModified();
246    }
247    
248    public EntityInstancePK getRatedEntityInstancePK() {
249        return _value.getRatedEntityInstancePK();
250    }
251    
252    public EntityInstance getRatedEntityInstance(Session session, EntityPermission entityPermission) {
253        return EntityInstanceFactory.getInstance().getEntityFromPK(session, entityPermission, getRatedEntityInstancePK());
254    }
255    
256    public EntityInstance getRatedEntityInstance(EntityPermission entityPermission) {
257        return getRatedEntityInstance(ThreadSession.currentSession(), entityPermission);
258    }
259    
260    public EntityInstance getRatedEntityInstance(Session session) {
261        return getRatedEntityInstance(session, EntityPermission.READ_ONLY);
262    }
263    
264    public EntityInstance getRatedEntityInstance() {
265        return getRatedEntityInstance(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
266    }
267    
268    public EntityInstance getRatedEntityInstanceForUpdate(Session session) {
269        return getRatedEntityInstance(session, EntityPermission.READ_WRITE);
270    }
271    
272    public EntityInstance getRatedEntityInstanceForUpdate() {
273        return getRatedEntityInstance(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
274    }
275    
276    public void setRatedEntityInstancePK(EntityInstancePK ratedEntityInstancePK)
277            throws PersistenceNotNullException, PersistenceReadOnlyException {
278        checkReadWrite();
279        _value.setRatedEntityInstancePK(ratedEntityInstancePK);
280    }
281    
282    public void setRatedEntityInstance(EntityInstance entity) {
283        setRatedEntityInstancePK(entity == null? null: entity.getPrimaryKey());
284    }
285    
286    public boolean getRatedEntityInstancePKHasBeenModified() {
287        return _value.getRatedEntityInstancePKHasBeenModified();
288    }
289    
290    public EntityInstancePK getRatedByEntityInstancePK() {
291        return _value.getRatedByEntityInstancePK();
292    }
293    
294    public EntityInstance getRatedByEntityInstance(Session session, EntityPermission entityPermission) {
295        return EntityInstanceFactory.getInstance().getEntityFromPK(session, entityPermission, getRatedByEntityInstancePK());
296    }
297    
298    public EntityInstance getRatedByEntityInstance(EntityPermission entityPermission) {
299        return getRatedByEntityInstance(ThreadSession.currentSession(), entityPermission);
300    }
301    
302    public EntityInstance getRatedByEntityInstance(Session session) {
303        return getRatedByEntityInstance(session, EntityPermission.READ_ONLY);
304    }
305    
306    public EntityInstance getRatedByEntityInstance() {
307        return getRatedByEntityInstance(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
308    }
309    
310    public EntityInstance getRatedByEntityInstanceForUpdate(Session session) {
311        return getRatedByEntityInstance(session, EntityPermission.READ_WRITE);
312    }
313    
314    public EntityInstance getRatedByEntityInstanceForUpdate() {
315        return getRatedByEntityInstance(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
316    }
317    
318    public void setRatedByEntityInstancePK(EntityInstancePK ratedByEntityInstancePK)
319            throws PersistenceNotNullException, PersistenceReadOnlyException {
320        checkReadWrite();
321        _value.setRatedByEntityInstancePK(ratedByEntityInstancePK);
322    }
323    
324    public void setRatedByEntityInstance(EntityInstance entity) {
325        setRatedByEntityInstancePK(entity == null? null: entity.getPrimaryKey());
326    }
327    
328    public boolean getRatedByEntityInstancePKHasBeenModified() {
329        return _value.getRatedByEntityInstancePKHasBeenModified();
330    }
331    
332    public Long getFromTime() {
333        return _value.getFromTime();
334    }
335    
336    public void setFromTime(Long fromTime)
337            throws PersistenceNotNullException, PersistenceReadOnlyException {
338        checkReadWrite();
339        _value.setFromTime(fromTime);
340    }
341    
342    public boolean getFromTimeHasBeenModified() {
343        return _value.getFromTimeHasBeenModified();
344    }
345    
346    public Long getThruTime() {
347        return _value.getThruTime();
348    }
349    
350    public void setThruTime(Long thruTime)
351            throws PersistenceNotNullException, PersistenceReadOnlyException {
352        checkReadWrite();
353        _value.setThruTime(thruTime);
354    }
355    
356    public boolean getThruTimeHasBeenModified() {
357        return _value.getThruTimeHasBeenModified();
358    }
359    
360}