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 * 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()
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 RelatedItemDetailValue getRelatedItemDetailValue() {
128        return _value;
129    }
130    
131    public void setRelatedItemDetailValue(RelatedItemDetailValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    public RelatedItemDetailPK getPrimaryKey() {
139        return _pk;
140    }
141    
142    public RelatedItemPK getRelatedItemPK() {
143        return _value.getRelatedItemPK();
144    }
145    
146    public RelatedItem getRelatedItem(EntityPermission entityPermission) {
147        return RelatedItemFactory.getInstance().getEntityFromPK(entityPermission, getRelatedItemPK());
148    }
149    
150    public RelatedItem getRelatedItem() {
151        return getRelatedItem(EntityPermission.READ_ONLY);
152    }
153    
154    public RelatedItem getRelatedItemForUpdate() {
155        return getRelatedItem(EntityPermission.READ_WRITE);
156    }
157    
158    public void setRelatedItemPK(RelatedItemPK relatedItemPK)
159            throws PersistenceNotNullException, PersistenceReadOnlyException {
160        checkReadWrite();
161        _value.setRelatedItemPK(relatedItemPK);
162    }
163    
164    public void setRelatedItem(RelatedItem entity) {
165        setRelatedItemPK(entity == null? null: entity.getPrimaryKey());
166    }
167    
168    public boolean getRelatedItemPKHasBeenModified() {
169        return _value.getRelatedItemPKHasBeenModified();
170    }
171    
172    public RelatedItemTypePK getRelatedItemTypePK() {
173        return _value.getRelatedItemTypePK();
174    }
175    
176    public RelatedItemType getRelatedItemType(EntityPermission entityPermission) {
177        return RelatedItemTypeFactory.getInstance().getEntityFromPK(entityPermission, getRelatedItemTypePK());
178    }
179    
180    public RelatedItemType getRelatedItemType() {
181        return getRelatedItemType(EntityPermission.READ_ONLY);
182    }
183    
184    public RelatedItemType getRelatedItemTypeForUpdate() {
185        return getRelatedItemType(EntityPermission.READ_WRITE);
186    }
187    
188    public void setRelatedItemTypePK(RelatedItemTypePK relatedItemTypePK)
189            throws PersistenceNotNullException, PersistenceReadOnlyException {
190        checkReadWrite();
191        _value.setRelatedItemTypePK(relatedItemTypePK);
192    }
193    
194    public void setRelatedItemType(RelatedItemType entity) {
195        setRelatedItemTypePK(entity == null? null: entity.getPrimaryKey());
196    }
197    
198    public boolean getRelatedItemTypePKHasBeenModified() {
199        return _value.getRelatedItemTypePKHasBeenModified();
200    }
201    
202    public ItemPK getFromItemPK() {
203        return _value.getFromItemPK();
204    }
205    
206    public Item getFromItem(EntityPermission entityPermission) {
207        return ItemFactory.getInstance().getEntityFromPK(entityPermission, getFromItemPK());
208    }
209    
210    public Item getFromItem() {
211        return getFromItem(EntityPermission.READ_ONLY);
212    }
213    
214    public Item getFromItemForUpdate() {
215        return getFromItem(EntityPermission.READ_WRITE);
216    }
217    
218    public void setFromItemPK(ItemPK fromItemPK)
219            throws PersistenceNotNullException, PersistenceReadOnlyException {
220        checkReadWrite();
221        _value.setFromItemPK(fromItemPK);
222    }
223    
224    public void setFromItem(Item entity) {
225        setFromItemPK(entity == null? null: entity.getPrimaryKey());
226    }
227    
228    public boolean getFromItemPKHasBeenModified() {
229        return _value.getFromItemPKHasBeenModified();
230    }
231    
232    public ItemPK getToItemPK() {
233        return _value.getToItemPK();
234    }
235    
236    public Item getToItem(EntityPermission entityPermission) {
237        return ItemFactory.getInstance().getEntityFromPK(entityPermission, getToItemPK());
238    }
239    
240    public Item getToItem() {
241        return getToItem(EntityPermission.READ_ONLY);
242    }
243    
244    public Item getToItemForUpdate() {
245        return getToItem(EntityPermission.READ_WRITE);
246    }
247    
248    public void setToItemPK(ItemPK toItemPK)
249            throws PersistenceNotNullException, PersistenceReadOnlyException {
250        checkReadWrite();
251        _value.setToItemPK(toItemPK);
252    }
253    
254    public void setToItem(Item entity) {
255        setToItemPK(entity == null? null: entity.getPrimaryKey());
256    }
257    
258    public boolean getToItemPKHasBeenModified() {
259        return _value.getToItemPKHasBeenModified();
260    }
261    
262    public Integer getSortOrder() {
263        return _value.getSortOrder();
264    }
265    
266    public void setSortOrder(Integer sortOrder)
267            throws PersistenceNotNullException, PersistenceReadOnlyException {
268        checkReadWrite();
269        _value.setSortOrder(sortOrder);
270    }
271    
272    public boolean getSortOrderHasBeenModified() {
273        return _value.getSortOrderHasBeenModified();
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}