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 * 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) {
108            RelatedItemDetail that = (RelatedItemDetail)other;
109            
110            RelatedItemDetailValue thatValue = that.getRelatedItemDetailValue();
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 RelatedItemDetailValue getRelatedItemDetailValue() {
136        return _value;
137    }
138    
139    public void setRelatedItemDetailValue(RelatedItemDetailValue value)
140            throws PersistenceReadOnlyException {
141        checkReadWrite();
142        _value = value;
143    }
144    
145    @Override
146    public RelatedItemDetailPK getPrimaryKey() {
147        return _pk;
148    }
149    
150    public RelatedItemPK getRelatedItemPK() {
151        return _value.getRelatedItemPK();
152    }
153    
154    public RelatedItem getRelatedItem(Session session, EntityPermission entityPermission) {
155        return RelatedItemFactory.getInstance().getEntityFromPK(session, entityPermission, getRelatedItemPK());
156    }
157    
158    public RelatedItem getRelatedItem(EntityPermission entityPermission) {
159        return getRelatedItem(ThreadSession.currentSession(), entityPermission);
160    }
161    
162    public RelatedItem getRelatedItem(Session session) {
163        return getRelatedItem(session, EntityPermission.READ_ONLY);
164    }
165    
166    public RelatedItem getRelatedItem() {
167        return getRelatedItem(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
168    }
169    
170    public RelatedItem getRelatedItemForUpdate(Session session) {
171        return getRelatedItem(session, EntityPermission.READ_WRITE);
172    }
173    
174    public RelatedItem getRelatedItemForUpdate() {
175        return getRelatedItem(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
176    }
177    
178    public void setRelatedItemPK(RelatedItemPK relatedItemPK)
179            throws PersistenceNotNullException, PersistenceReadOnlyException {
180        checkReadWrite();
181        _value.setRelatedItemPK(relatedItemPK);
182    }
183    
184    public void setRelatedItem(RelatedItem entity) {
185        setRelatedItemPK(entity == null? null: entity.getPrimaryKey());
186    }
187    
188    public boolean getRelatedItemPKHasBeenModified() {
189        return _value.getRelatedItemPKHasBeenModified();
190    }
191    
192    public RelatedItemTypePK getRelatedItemTypePK() {
193        return _value.getRelatedItemTypePK();
194    }
195    
196    public RelatedItemType getRelatedItemType(Session session, EntityPermission entityPermission) {
197        return RelatedItemTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getRelatedItemTypePK());
198    }
199    
200    public RelatedItemType getRelatedItemType(EntityPermission entityPermission) {
201        return getRelatedItemType(ThreadSession.currentSession(), entityPermission);
202    }
203    
204    public RelatedItemType getRelatedItemType(Session session) {
205        return getRelatedItemType(session, EntityPermission.READ_ONLY);
206    }
207    
208    public RelatedItemType getRelatedItemType() {
209        return getRelatedItemType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
210    }
211    
212    public RelatedItemType getRelatedItemTypeForUpdate(Session session) {
213        return getRelatedItemType(session, EntityPermission.READ_WRITE);
214    }
215    
216    public RelatedItemType getRelatedItemTypeForUpdate() {
217        return getRelatedItemType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
218    }
219    
220    public void setRelatedItemTypePK(RelatedItemTypePK relatedItemTypePK)
221            throws PersistenceNotNullException, PersistenceReadOnlyException {
222        checkReadWrite();
223        _value.setRelatedItemTypePK(relatedItemTypePK);
224    }
225    
226    public void setRelatedItemType(RelatedItemType entity) {
227        setRelatedItemTypePK(entity == null? null: entity.getPrimaryKey());
228    }
229    
230    public boolean getRelatedItemTypePKHasBeenModified() {
231        return _value.getRelatedItemTypePKHasBeenModified();
232    }
233    
234    public ItemPK getFromItemPK() {
235        return _value.getFromItemPK();
236    }
237    
238    public Item getFromItem(Session session, EntityPermission entityPermission) {
239        return ItemFactory.getInstance().getEntityFromPK(session, entityPermission, getFromItemPK());
240    }
241    
242    public Item getFromItem(EntityPermission entityPermission) {
243        return getFromItem(ThreadSession.currentSession(), entityPermission);
244    }
245    
246    public Item getFromItem(Session session) {
247        return getFromItem(session, EntityPermission.READ_ONLY);
248    }
249    
250    public Item getFromItem() {
251        return getFromItem(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
252    }
253    
254    public Item getFromItemForUpdate(Session session) {
255        return getFromItem(session, EntityPermission.READ_WRITE);
256    }
257    
258    public Item getFromItemForUpdate() {
259        return getFromItem(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
260    }
261    
262    public void setFromItemPK(ItemPK fromItemPK)
263            throws PersistenceNotNullException, PersistenceReadOnlyException {
264        checkReadWrite();
265        _value.setFromItemPK(fromItemPK);
266    }
267    
268    public void setFromItem(Item entity) {
269        setFromItemPK(entity == null? null: entity.getPrimaryKey());
270    }
271    
272    public boolean getFromItemPKHasBeenModified() {
273        return _value.getFromItemPKHasBeenModified();
274    }
275    
276    public ItemPK getToItemPK() {
277        return _value.getToItemPK();
278    }
279    
280    public Item getToItem(Session session, EntityPermission entityPermission) {
281        return ItemFactory.getInstance().getEntityFromPK(session, entityPermission, getToItemPK());
282    }
283    
284    public Item getToItem(EntityPermission entityPermission) {
285        return getToItem(ThreadSession.currentSession(), entityPermission);
286    }
287    
288    public Item getToItem(Session session) {
289        return getToItem(session, EntityPermission.READ_ONLY);
290    }
291    
292    public Item getToItem() {
293        return getToItem(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
294    }
295    
296    public Item getToItemForUpdate(Session session) {
297        return getToItem(session, EntityPermission.READ_WRITE);
298    }
299    
300    public Item getToItemForUpdate() {
301        return getToItem(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
302    }
303    
304    public void setToItemPK(ItemPK toItemPK)
305            throws PersistenceNotNullException, PersistenceReadOnlyException {
306        checkReadWrite();
307        _value.setToItemPK(toItemPK);
308    }
309    
310    public void setToItem(Item entity) {
311        setToItemPK(entity == null? null: entity.getPrimaryKey());
312    }
313    
314    public boolean getToItemPKHasBeenModified() {
315        return _value.getToItemPKHasBeenModified();
316    }
317    
318    public Integer getSortOrder() {
319        return _value.getSortOrder();
320    }
321    
322    public void setSortOrder(Integer sortOrder)
323            throws PersistenceNotNullException, PersistenceReadOnlyException {
324        checkReadWrite();
325        _value.setSortOrder(sortOrder);
326    }
327    
328    public boolean getSortOrderHasBeenModified() {
329        return _value.getSortOrderHasBeenModified();
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}