001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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 * RelatedItemDetail.java
021 */
022
023package com.echothree.model.data.item.server.entity;
024
025import com.echothree.model.data.item.common.pk.RelatedItemDetailPK;
026
027import com.echothree.model.data.item.common.pk.RelatedItemPK;
028import com.echothree.model.data.item.common.pk.RelatedItemTypePK;
029import com.echothree.model.data.item.common.pk.ItemPK;
030
031import com.echothree.model.data.item.server.entity.RelatedItem;
032import com.echothree.model.data.item.server.entity.RelatedItemType;
033import com.echothree.model.data.item.server.entity.Item;
034
035import com.echothree.model.data.item.server.factory.RelatedItemFactory;
036import com.echothree.model.data.item.server.factory.RelatedItemTypeFactory;
037import com.echothree.model.data.item.server.factory.ItemFactory;
038
039import com.echothree.model.data.item.common.pk.RelatedItemDetailPK;
040
041import com.echothree.model.data.item.server.value.RelatedItemDetailValue;
042
043import com.echothree.model.data.item.server.factory.RelatedItemDetailFactory;
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 RelatedItemDetail
062        extends BaseEntity
063        implements Serializable {
064    
065    private RelatedItemDetailPK _pk;
066    private RelatedItemDetailValue _value;
067    
068    /** Creates a new instance of RelatedItemDetail */
069    public RelatedItemDetail()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of RelatedItemDetail */
075    public RelatedItemDetail(RelatedItemDetailValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public RelatedItemDetailFactory getBaseFactoryInstance() {
084        return RelatedItemDetailFactory.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 RelatedItemDetail that) {
108            RelatedItemDetailValue thatValue = that.getRelatedItemDetailValue();
109            return _value.equals(thatValue);
110        } else {
111            return false;
112        }
113    }
114    
115    @Override
116    public void store(Session session)
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().store(session, this);
119    }
120    
121    @Override
122    public void remove(Session session)
123            throws PersistenceDatabaseException {
124        getBaseFactoryInstance().remove(session, this);
125    }
126    
127    @Override
128    public void remove()
129            throws PersistenceDatabaseException {
130        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
131    }
132    
133    public RelatedItemDetailValue getRelatedItemDetailValue() {
134        return _value;
135    }
136    
137    public void setRelatedItemDetailValue(RelatedItemDetailValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    public RelatedItemDetailPK getPrimaryKey() {
145        return _pk;
146    }
147    
148    public RelatedItemPK getRelatedItemPK() {
149        return _value.getRelatedItemPK();
150    }
151    
152    public RelatedItem getRelatedItem(Session session, EntityPermission entityPermission) {
153        return RelatedItemFactory.getInstance().getEntityFromPK(session, entityPermission, getRelatedItemPK());
154    }
155    
156    public RelatedItem getRelatedItem(EntityPermission entityPermission) {
157        return getRelatedItem(ThreadSession.currentSession(), entityPermission);
158    }
159    
160    public RelatedItem getRelatedItem(Session session) {
161        return getRelatedItem(session, EntityPermission.READ_ONLY);
162    }
163    
164    public RelatedItem getRelatedItem() {
165        return getRelatedItem(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
166    }
167    
168    public RelatedItem getRelatedItemForUpdate(Session session) {
169        return getRelatedItem(session, EntityPermission.READ_WRITE);
170    }
171    
172    public RelatedItem getRelatedItemForUpdate() {
173        return getRelatedItem(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
174    }
175    
176    public void setRelatedItemPK(RelatedItemPK relatedItemPK)
177            throws PersistenceNotNullException, PersistenceReadOnlyException {
178        checkReadWrite();
179        _value.setRelatedItemPK(relatedItemPK);
180    }
181    
182    public void setRelatedItem(RelatedItem entity) {
183        setRelatedItemPK(entity == null? null: entity.getPrimaryKey());
184    }
185    
186    public boolean getRelatedItemPKHasBeenModified() {
187        return _value.getRelatedItemPKHasBeenModified();
188    }
189    
190    public RelatedItemTypePK getRelatedItemTypePK() {
191        return _value.getRelatedItemTypePK();
192    }
193    
194    public RelatedItemType getRelatedItemType(Session session, EntityPermission entityPermission) {
195        return RelatedItemTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getRelatedItemTypePK());
196    }
197    
198    public RelatedItemType getRelatedItemType(EntityPermission entityPermission) {
199        return getRelatedItemType(ThreadSession.currentSession(), entityPermission);
200    }
201    
202    public RelatedItemType getRelatedItemType(Session session) {
203        return getRelatedItemType(session, EntityPermission.READ_ONLY);
204    }
205    
206    public RelatedItemType getRelatedItemType() {
207        return getRelatedItemType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
208    }
209    
210    public RelatedItemType getRelatedItemTypeForUpdate(Session session) {
211        return getRelatedItemType(session, EntityPermission.READ_WRITE);
212    }
213    
214    public RelatedItemType getRelatedItemTypeForUpdate() {
215        return getRelatedItemType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
216    }
217    
218    public void setRelatedItemTypePK(RelatedItemTypePK relatedItemTypePK)
219            throws PersistenceNotNullException, PersistenceReadOnlyException {
220        checkReadWrite();
221        _value.setRelatedItemTypePK(relatedItemTypePK);
222    }
223    
224    public void setRelatedItemType(RelatedItemType entity) {
225        setRelatedItemTypePK(entity == null? null: entity.getPrimaryKey());
226    }
227    
228    public boolean getRelatedItemTypePKHasBeenModified() {
229        return _value.getRelatedItemTypePKHasBeenModified();
230    }
231    
232    public ItemPK getFromItemPK() {
233        return _value.getFromItemPK();
234    }
235    
236    public Item getFromItem(Session session, EntityPermission entityPermission) {
237        return ItemFactory.getInstance().getEntityFromPK(session, entityPermission, getFromItemPK());
238    }
239    
240    public Item getFromItem(EntityPermission entityPermission) {
241        return getFromItem(ThreadSession.currentSession(), entityPermission);
242    }
243    
244    public Item getFromItem(Session session) {
245        return getFromItem(session, EntityPermission.READ_ONLY);
246    }
247    
248    public Item getFromItem() {
249        return getFromItem(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
250    }
251    
252    public Item getFromItemForUpdate(Session session) {
253        return getFromItem(session, EntityPermission.READ_WRITE);
254    }
255    
256    public Item getFromItemForUpdate() {
257        return getFromItem(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
258    }
259    
260    public void setFromItemPK(ItemPK fromItemPK)
261            throws PersistenceNotNullException, PersistenceReadOnlyException {
262        checkReadWrite();
263        _value.setFromItemPK(fromItemPK);
264    }
265    
266    public void setFromItem(Item entity) {
267        setFromItemPK(entity == null? null: entity.getPrimaryKey());
268    }
269    
270    public boolean getFromItemPKHasBeenModified() {
271        return _value.getFromItemPKHasBeenModified();
272    }
273    
274    public ItemPK getToItemPK() {
275        return _value.getToItemPK();
276    }
277    
278    public Item getToItem(Session session, EntityPermission entityPermission) {
279        return ItemFactory.getInstance().getEntityFromPK(session, entityPermission, getToItemPK());
280    }
281    
282    public Item getToItem(EntityPermission entityPermission) {
283        return getToItem(ThreadSession.currentSession(), entityPermission);
284    }
285    
286    public Item getToItem(Session session) {
287        return getToItem(session, EntityPermission.READ_ONLY);
288    }
289    
290    public Item getToItem() {
291        return getToItem(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
292    }
293    
294    public Item getToItemForUpdate(Session session) {
295        return getToItem(session, EntityPermission.READ_WRITE);
296    }
297    
298    public Item getToItemForUpdate() {
299        return getToItem(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
300    }
301    
302    public void setToItemPK(ItemPK toItemPK)
303            throws PersistenceNotNullException, PersistenceReadOnlyException {
304        checkReadWrite();
305        _value.setToItemPK(toItemPK);
306    }
307    
308    public void setToItem(Item entity) {
309        setToItemPK(entity == null? null: entity.getPrimaryKey());
310    }
311    
312    public boolean getToItemPKHasBeenModified() {
313        return _value.getToItemPKHasBeenModified();
314    }
315    
316    public Integer getSortOrder() {
317        return _value.getSortOrder();
318    }
319    
320    public void setSortOrder(Integer sortOrder)
321            throws PersistenceNotNullException, PersistenceReadOnlyException {
322        checkReadWrite();
323        _value.setSortOrder(sortOrder);
324    }
325    
326    public boolean getSortOrderHasBeenModified() {
327        return _value.getSortOrderHasBeenModified();
328    }
329    
330    public Long getFromTime() {
331        return _value.getFromTime();
332    }
333    
334    public void setFromTime(Long fromTime)
335            throws PersistenceNotNullException, PersistenceReadOnlyException {
336        checkReadWrite();
337        _value.setFromTime(fromTime);
338    }
339    
340    public boolean getFromTimeHasBeenModified() {
341        return _value.getFromTimeHasBeenModified();
342    }
343    
344    public Long getThruTime() {
345        return _value.getThruTime();
346    }
347    
348    public void setThruTime(Long thruTime)
349            throws PersistenceNotNullException, PersistenceReadOnlyException {
350        checkReadWrite();
351        _value.setThruTime(thruTime);
352    }
353    
354    public boolean getThruTimeHasBeenModified() {
355        return _value.getThruTimeHasBeenModified();
356    }
357    
358}