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 * LocationVolume.java
021 */
022
023package com.echothree.model.data.warehouse.server.entity;
024
025import com.echothree.model.data.warehouse.common.pk.LocationVolumePK;
026
027import com.echothree.model.data.warehouse.common.pk.LocationPK;
028
029import com.echothree.model.data.warehouse.server.entity.Location;
030
031import com.echothree.model.data.warehouse.server.factory.LocationFactory;
032
033import com.echothree.model.data.warehouse.common.pk.LocationVolumePK;
034
035import com.echothree.model.data.warehouse.server.value.LocationVolumeValue;
036
037import com.echothree.model.data.warehouse.server.factory.LocationVolumeFactory;
038
039import com.echothree.util.common.exception.PersistenceException;
040import com.echothree.util.common.exception.PersistenceDatabaseException;
041import com.echothree.util.common.exception.PersistenceNotNullException;
042import com.echothree.util.common.exception.PersistenceReadOnlyException;
043
044import com.echothree.util.common.persistence.BasePK;
045
046import com.echothree.util.common.persistence.type.ByteArray;
047
048import com.echothree.util.server.persistence.BaseEntity;
049import com.echothree.util.server.persistence.EntityPermission;
050import com.echothree.util.server.persistence.Session;
051import com.echothree.util.server.persistence.ThreadSession;
052
053import java.io.Serializable;
054
055public class LocationVolume
056        extends BaseEntity
057        implements Serializable {
058    
059    private LocationVolumePK _pk;
060    private LocationVolumeValue _value;
061    
062    /** Creates a new instance of LocationVolume */
063    public LocationVolume()
064            throws PersistenceException {
065        super();
066    }
067    
068    /** Creates a new instance of LocationVolume */
069    public LocationVolume(LocationVolumeValue value, EntityPermission entityPermission) {
070        super(entityPermission);
071        
072        _value = value;
073        _pk = value.getPrimaryKey();
074    }
075    
076    @Override
077    public LocationVolumeFactory getBaseFactoryInstance() {
078        return LocationVolumeFactory.getInstance();
079    }
080    
081    @Override
082    public boolean hasBeenModified() {
083        return _value.hasBeenModified();
084    }
085    
086    @Override
087    public int hashCode() {
088        return _pk.hashCode();
089    }
090    
091    @Override
092    public String toString() {
093        return _pk.toString();
094    }
095    
096    @Override
097    public boolean equals(Object other) {
098        if(this == other)
099            return true;
100        
101        if(other instanceof LocationVolume that) {
102            LocationVolumeValue thatValue = that.getLocationVolumeValue();
103            return _value.equals(thatValue);
104        } else {
105            return false;
106        }
107    }
108    
109    @Override
110    public void store(Session session)
111            throws PersistenceDatabaseException {
112        getBaseFactoryInstance().store(session, this);
113    }
114    
115    @Override
116    public void remove(Session session)
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().remove(session, this);
119    }
120    
121    @Override
122    public void remove()
123            throws PersistenceDatabaseException {
124        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
125    }
126    
127    public LocationVolumeValue getLocationVolumeValue() {
128        return _value;
129    }
130    
131    public void setLocationVolumeValue(LocationVolumeValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    public LocationVolumePK getPrimaryKey() {
139        return _pk;
140    }
141    
142    public LocationPK getLocationPK() {
143        return _value.getLocationPK();
144    }
145    
146    public Location getLocation(Session session, EntityPermission entityPermission) {
147        return LocationFactory.getInstance().getEntityFromPK(session, entityPermission, getLocationPK());
148    }
149    
150    public Location getLocation(EntityPermission entityPermission) {
151        return getLocation(ThreadSession.currentSession(), entityPermission);
152    }
153    
154    public Location getLocation(Session session) {
155        return getLocation(session, EntityPermission.READ_ONLY);
156    }
157    
158    public Location getLocation() {
159        return getLocation(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
160    }
161    
162    public Location getLocationForUpdate(Session session) {
163        return getLocation(session, EntityPermission.READ_WRITE);
164    }
165    
166    public Location getLocationForUpdate() {
167        return getLocation(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
168    }
169    
170    public void setLocationPK(LocationPK locationPK)
171            throws PersistenceNotNullException, PersistenceReadOnlyException {
172        checkReadWrite();
173        _value.setLocationPK(locationPK);
174    }
175    
176    public void setLocation(Location entity) {
177        setLocationPK(entity == null? null: entity.getPrimaryKey());
178    }
179    
180    public boolean getLocationPKHasBeenModified() {
181        return _value.getLocationPKHasBeenModified();
182    }
183    
184    public Long getHeight() {
185        return _value.getHeight();
186    }
187    
188    public void setHeight(Long height)
189            throws PersistenceNotNullException, PersistenceReadOnlyException {
190        checkReadWrite();
191        _value.setHeight(height);
192    }
193    
194    public boolean getHeightHasBeenModified() {
195        return _value.getHeightHasBeenModified();
196    }
197    
198    public Long getWidth() {
199        return _value.getWidth();
200    }
201    
202    public void setWidth(Long width)
203            throws PersistenceNotNullException, PersistenceReadOnlyException {
204        checkReadWrite();
205        _value.setWidth(width);
206    }
207    
208    public boolean getWidthHasBeenModified() {
209        return _value.getWidthHasBeenModified();
210    }
211    
212    public Long getDepth() {
213        return _value.getDepth();
214    }
215    
216    public void setDepth(Long depth)
217            throws PersistenceNotNullException, PersistenceReadOnlyException {
218        checkReadWrite();
219        _value.setDepth(depth);
220    }
221    
222    public boolean getDepthHasBeenModified() {
223        return _value.getDepthHasBeenModified();
224    }
225    
226    public Long getFromTime() {
227        return _value.getFromTime();
228    }
229    
230    public void setFromTime(Long fromTime)
231            throws PersistenceNotNullException, PersistenceReadOnlyException {
232        checkReadWrite();
233        _value.setFromTime(fromTime);
234    }
235    
236    public boolean getFromTimeHasBeenModified() {
237        return _value.getFromTimeHasBeenModified();
238    }
239    
240    public Long getThruTime() {
241        return _value.getThruTime();
242    }
243    
244    public void setThruTime(Long thruTime)
245            throws PersistenceNotNullException, PersistenceReadOnlyException {
246        checkReadWrite();
247        _value.setThruTime(thruTime);
248    }
249    
250    public boolean getThruTimeHasBeenModified() {
251        return _value.getThruTimeHasBeenModified();
252    }
253    
254}