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 * 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()
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 ItemVolumeValue getItemVolumeValue() {
128        return _value;
129    }
130    
131    public void setItemVolumeValue(ItemVolumeValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    public ItemVolumePK getPrimaryKey() {
139        return _pk;
140    }
141    
142    public ItemPK getItemPK() {
143        return _value.getItemPK();
144    }
145    
146    public Item getItem(EntityPermission entityPermission) {
147        return ItemFactory.getInstance().getEntityFromPK(entityPermission, getItemPK());
148    }
149    
150    public Item getItem() {
151        return getItem(EntityPermission.READ_ONLY);
152    }
153    
154    public Item getItemForUpdate() {
155        return getItem(EntityPermission.READ_WRITE);
156    }
157    
158    public void setItemPK(ItemPK itemPK)
159            throws PersistenceNotNullException, PersistenceReadOnlyException {
160        checkReadWrite();
161        _value.setItemPK(itemPK);
162    }
163    
164    public void setItem(Item entity) {
165        setItemPK(entity == null? null: entity.getPrimaryKey());
166    }
167    
168    public boolean getItemPKHasBeenModified() {
169        return _value.getItemPKHasBeenModified();
170    }
171    
172    public UnitOfMeasureTypePK getUnitOfMeasureTypePK() {
173        return _value.getUnitOfMeasureTypePK();
174    }
175    
176    public UnitOfMeasureType getUnitOfMeasureType(EntityPermission entityPermission) {
177        return UnitOfMeasureTypeFactory.getInstance().getEntityFromPK(entityPermission, getUnitOfMeasureTypePK());
178    }
179    
180    public UnitOfMeasureType getUnitOfMeasureType() {
181        return getUnitOfMeasureType(EntityPermission.READ_ONLY);
182    }
183    
184    public UnitOfMeasureType getUnitOfMeasureTypeForUpdate() {
185        return getUnitOfMeasureType(EntityPermission.READ_WRITE);
186    }
187    
188    public void setUnitOfMeasureTypePK(UnitOfMeasureTypePK unitOfMeasureTypePK)
189            throws PersistenceNotNullException, PersistenceReadOnlyException {
190        checkReadWrite();
191        _value.setUnitOfMeasureTypePK(unitOfMeasureTypePK);
192    }
193    
194    public void setUnitOfMeasureType(UnitOfMeasureType entity) {
195        setUnitOfMeasureTypePK(entity == null? null: entity.getPrimaryKey());
196    }
197    
198    public boolean getUnitOfMeasureTypePKHasBeenModified() {
199        return _value.getUnitOfMeasureTypePKHasBeenModified();
200    }
201    
202    public ItemVolumeTypePK getItemVolumeTypePK() {
203        return _value.getItemVolumeTypePK();
204    }
205    
206    public ItemVolumeType getItemVolumeType(EntityPermission entityPermission) {
207        return ItemVolumeTypeFactory.getInstance().getEntityFromPK(entityPermission, getItemVolumeTypePK());
208    }
209    
210    public ItemVolumeType getItemVolumeType() {
211        return getItemVolumeType(EntityPermission.READ_ONLY);
212    }
213    
214    public ItemVolumeType getItemVolumeTypeForUpdate() {
215        return getItemVolumeType(EntityPermission.READ_WRITE);
216    }
217    
218    public void setItemVolumeTypePK(ItemVolumeTypePK itemVolumeTypePK)
219            throws PersistenceNotNullException, PersistenceReadOnlyException {
220        checkReadWrite();
221        _value.setItemVolumeTypePK(itemVolumeTypePK);
222    }
223    
224    public void setItemVolumeType(ItemVolumeType entity) {
225        setItemVolumeTypePK(entity == null? null: entity.getPrimaryKey());
226    }
227    
228    public boolean getItemVolumeTypePKHasBeenModified() {
229        return _value.getItemVolumeTypePKHasBeenModified();
230    }
231    
232    public Long getHeight() {
233        return _value.getHeight();
234    }
235    
236    public void setHeight(Long height)
237            throws PersistenceNotNullException, PersistenceReadOnlyException {
238        checkReadWrite();
239        _value.setHeight(height);
240    }
241    
242    public boolean getHeightHasBeenModified() {
243        return _value.getHeightHasBeenModified();
244    }
245    
246    public Long getWidth() {
247        return _value.getWidth();
248    }
249    
250    public void setWidth(Long width)
251            throws PersistenceNotNullException, PersistenceReadOnlyException {
252        checkReadWrite();
253        _value.setWidth(width);
254    }
255    
256    public boolean getWidthHasBeenModified() {
257        return _value.getWidthHasBeenModified();
258    }
259    
260    public Long getDepth() {
261        return _value.getDepth();
262    }
263    
264    public void setDepth(Long depth)
265            throws PersistenceNotNullException, PersistenceReadOnlyException {
266        checkReadWrite();
267        _value.setDepth(depth);
268    }
269    
270    public boolean getDepthHasBeenModified() {
271        return _value.getDepthHasBeenModified();
272    }
273    
274    public Long getFromTime() {
275        return _value.getFromTime();
276    }
277    
278    public void setFromTime(Long fromTime)
279            throws PersistenceNotNullException, PersistenceReadOnlyException {
280        checkReadWrite();
281        _value.setFromTime(fromTime);
282    }
283    
284    public boolean getFromTimeHasBeenModified() {
285        return _value.getFromTimeHasBeenModified();
286    }
287    
288    public Long getThruTime() {
289        return _value.getThruTime();
290    }
291    
292    public void setThruTime(Long thruTime)
293            throws PersistenceNotNullException, PersistenceReadOnlyException {
294        checkReadWrite();
295        _value.setThruTime(thruTime);
296    }
297    
298    public boolean getThruTimeHasBeenModified() {
299        return _value.getThruTimeHasBeenModified();
300    }
301    
302}