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 * ItemVolume.java
021 */
022
023package com.echothree.model.data.item.server.entity;
024
025import com.echothree.model.data.item.common.pk.ItemVolumePK;
026
027import com.echothree.model.data.item.common.pk.ItemPK;
028import com.echothree.model.data.uom.common.pk.UnitOfMeasureTypePK;
029import com.echothree.model.data.item.common.pk.ItemVolumeTypePK;
030
031import com.echothree.model.data.item.server.entity.Item;
032import com.echothree.model.data.uom.server.entity.UnitOfMeasureType;
033import com.echothree.model.data.item.server.entity.ItemVolumeType;
034
035import com.echothree.model.data.item.server.factory.ItemFactory;
036import com.echothree.model.data.uom.server.factory.UnitOfMeasureTypeFactory;
037import com.echothree.model.data.item.server.factory.ItemVolumeTypeFactory;
038
039import com.echothree.model.data.item.common.pk.ItemVolumePK;
040
041import com.echothree.model.data.item.server.value.ItemVolumeValue;
042
043import com.echothree.model.data.item.server.factory.ItemVolumeFactory;
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 ItemVolume
062        extends BaseEntity
063        implements Serializable {
064    
065    private ItemVolumePK _pk;
066    private ItemVolumeValue _value;
067    
068    /** Creates a new instance of ItemVolume */
069    public ItemVolume()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of ItemVolume */
075    public ItemVolume(ItemVolumeValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public ItemVolumeFactory getBaseFactoryInstance() {
084        return ItemVolumeFactory.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 ItemVolume that) {
108            ItemVolumeValue thatValue = that.getItemVolumeValue();
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 ItemVolumeValue getItemVolumeValue() {
134        return _value;
135    }
136    
137    public void setItemVolumeValue(ItemVolumeValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    public ItemVolumePK getPrimaryKey() {
145        return _pk;
146    }
147    
148    public ItemPK getItemPK() {
149        return _value.getItemPK();
150    }
151    
152    public Item getItem(Session session, EntityPermission entityPermission) {
153        return ItemFactory.getInstance().getEntityFromPK(session, entityPermission, getItemPK());
154    }
155    
156    public Item getItem(EntityPermission entityPermission) {
157        return getItem(ThreadSession.currentSession(), entityPermission);
158    }
159    
160    public Item getItem(Session session) {
161        return getItem(session, EntityPermission.READ_ONLY);
162    }
163    
164    public Item getItem() {
165        return getItem(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
166    }
167    
168    public Item getItemForUpdate(Session session) {
169        return getItem(session, EntityPermission.READ_WRITE);
170    }
171    
172    public Item getItemForUpdate() {
173        return getItem(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
174    }
175    
176    public void setItemPK(ItemPK itemPK)
177            throws PersistenceNotNullException, PersistenceReadOnlyException {
178        checkReadWrite();
179        _value.setItemPK(itemPK);
180    }
181    
182    public void setItem(Item entity) {
183        setItemPK(entity == null? null: entity.getPrimaryKey());
184    }
185    
186    public boolean getItemPKHasBeenModified() {
187        return _value.getItemPKHasBeenModified();
188    }
189    
190    public UnitOfMeasureTypePK getUnitOfMeasureTypePK() {
191        return _value.getUnitOfMeasureTypePK();
192    }
193    
194    public UnitOfMeasureType getUnitOfMeasureType(Session session, EntityPermission entityPermission) {
195        return UnitOfMeasureTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getUnitOfMeasureTypePK());
196    }
197    
198    public UnitOfMeasureType getUnitOfMeasureType(EntityPermission entityPermission) {
199        return getUnitOfMeasureType(ThreadSession.currentSession(), entityPermission);
200    }
201    
202    public UnitOfMeasureType getUnitOfMeasureType(Session session) {
203        return getUnitOfMeasureType(session, EntityPermission.READ_ONLY);
204    }
205    
206    public UnitOfMeasureType getUnitOfMeasureType() {
207        return getUnitOfMeasureType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
208    }
209    
210    public UnitOfMeasureType getUnitOfMeasureTypeForUpdate(Session session) {
211        return getUnitOfMeasureType(session, EntityPermission.READ_WRITE);
212    }
213    
214    public UnitOfMeasureType getUnitOfMeasureTypeForUpdate() {
215        return getUnitOfMeasureType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
216    }
217    
218    public void setUnitOfMeasureTypePK(UnitOfMeasureTypePK unitOfMeasureTypePK)
219            throws PersistenceNotNullException, PersistenceReadOnlyException {
220        checkReadWrite();
221        _value.setUnitOfMeasureTypePK(unitOfMeasureTypePK);
222    }
223    
224    public void setUnitOfMeasureType(UnitOfMeasureType entity) {
225        setUnitOfMeasureTypePK(entity == null? null: entity.getPrimaryKey());
226    }
227    
228    public boolean getUnitOfMeasureTypePKHasBeenModified() {
229        return _value.getUnitOfMeasureTypePKHasBeenModified();
230    }
231    
232    public ItemVolumeTypePK getItemVolumeTypePK() {
233        return _value.getItemVolumeTypePK();
234    }
235    
236    public ItemVolumeType getItemVolumeType(Session session, EntityPermission entityPermission) {
237        return ItemVolumeTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getItemVolumeTypePK());
238    }
239    
240    public ItemVolumeType getItemVolumeType(EntityPermission entityPermission) {
241        return getItemVolumeType(ThreadSession.currentSession(), entityPermission);
242    }
243    
244    public ItemVolumeType getItemVolumeType(Session session) {
245        return getItemVolumeType(session, EntityPermission.READ_ONLY);
246    }
247    
248    public ItemVolumeType getItemVolumeType() {
249        return getItemVolumeType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
250    }
251    
252    public ItemVolumeType getItemVolumeTypeForUpdate(Session session) {
253        return getItemVolumeType(session, EntityPermission.READ_WRITE);
254    }
255    
256    public ItemVolumeType getItemVolumeTypeForUpdate() {
257        return getItemVolumeType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
258    }
259    
260    public void setItemVolumeTypePK(ItemVolumeTypePK itemVolumeTypePK)
261            throws PersistenceNotNullException, PersistenceReadOnlyException {
262        checkReadWrite();
263        _value.setItemVolumeTypePK(itemVolumeTypePK);
264    }
265    
266    public void setItemVolumeType(ItemVolumeType entity) {
267        setItemVolumeTypePK(entity == null? null: entity.getPrimaryKey());
268    }
269    
270    public boolean getItemVolumeTypePKHasBeenModified() {
271        return _value.getItemVolumeTypePKHasBeenModified();
272    }
273    
274    public Long getHeight() {
275        return _value.getHeight();
276    }
277    
278    public void setHeight(Long height)
279            throws PersistenceNotNullException, PersistenceReadOnlyException {
280        checkReadWrite();
281        _value.setHeight(height);
282    }
283    
284    public boolean getHeightHasBeenModified() {
285        return _value.getHeightHasBeenModified();
286    }
287    
288    public Long getWidth() {
289        return _value.getWidth();
290    }
291    
292    public void setWidth(Long width)
293            throws PersistenceNotNullException, PersistenceReadOnlyException {
294        checkReadWrite();
295        _value.setWidth(width);
296    }
297    
298    public boolean getWidthHasBeenModified() {
299        return _value.getWidthHasBeenModified();
300    }
301    
302    public Long getDepth() {
303        return _value.getDepth();
304    }
305    
306    public void setDepth(Long depth)
307            throws PersistenceNotNullException, PersistenceReadOnlyException {
308        checkReadWrite();
309        _value.setDepth(depth);
310    }
311    
312    public boolean getDepthHasBeenModified() {
313        return _value.getDepthHasBeenModified();
314    }
315    
316    public Long getFromTime() {
317        return _value.getFromTime();
318    }
319    
320    public void setFromTime(Long fromTime)
321            throws PersistenceNotNullException, PersistenceReadOnlyException {
322        checkReadWrite();
323        _value.setFromTime(fromTime);
324    }
325    
326    public boolean getFromTimeHasBeenModified() {
327        return _value.getFromTimeHasBeenModified();
328    }
329    
330    public Long getThruTime() {
331        return _value.getThruTime();
332    }
333    
334    public void setThruTime(Long thruTime)
335            throws PersistenceNotNullException, PersistenceReadOnlyException {
336        checkReadWrite();
337        _value.setThruTime(thruTime);
338    }
339    
340    public boolean getThruTimeHasBeenModified() {
341        return _value.getThruTimeHasBeenModified();
342    }
343    
344}