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 * 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) {
102            LocationVolume that = (LocationVolume)other;
103            
104            LocationVolumeValue thatValue = that.getLocationVolumeValue();
105            return _value.equals(thatValue);
106        } else {
107            return false;
108        }
109    }
110    
111    @Override
112    public void store(Session session)
113            throws PersistenceDatabaseException {
114        getBaseFactoryInstance().store(session, this);
115    }
116    
117    @Override
118    public void remove(Session session)
119            throws PersistenceDatabaseException {
120        getBaseFactoryInstance().remove(session, this);
121    }
122    
123    @Override
124    public void remove()
125            throws PersistenceDatabaseException {
126        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
127    }
128    
129    public LocationVolumeValue getLocationVolumeValue() {
130        return _value;
131    }
132    
133    public void setLocationVolumeValue(LocationVolumeValue value)
134            throws PersistenceReadOnlyException {
135        checkReadWrite();
136        _value = value;
137    }
138    
139    @Override
140    public LocationVolumePK getPrimaryKey() {
141        return _pk;
142    }
143    
144    public LocationPK getLocationPK() {
145        return _value.getLocationPK();
146    }
147    
148    public Location getLocation(Session session, EntityPermission entityPermission) {
149        return LocationFactory.getInstance().getEntityFromPK(session, entityPermission, getLocationPK());
150    }
151    
152    public Location getLocation(EntityPermission entityPermission) {
153        return getLocation(ThreadSession.currentSession(), entityPermission);
154    }
155    
156    public Location getLocation(Session session) {
157        return getLocation(session, EntityPermission.READ_ONLY);
158    }
159    
160    public Location getLocation() {
161        return getLocation(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
162    }
163    
164    public Location getLocationForUpdate(Session session) {
165        return getLocation(session, EntityPermission.READ_WRITE);
166    }
167    
168    public Location getLocationForUpdate() {
169        return getLocation(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
170    }
171    
172    public void setLocationPK(LocationPK locationPK)
173            throws PersistenceNotNullException, PersistenceReadOnlyException {
174        checkReadWrite();
175        _value.setLocationPK(locationPK);
176    }
177    
178    public void setLocation(Location entity) {
179        setLocationPK(entity == null? null: entity.getPrimaryKey());
180    }
181    
182    public boolean getLocationPKHasBeenModified() {
183        return _value.getLocationPKHasBeenModified();
184    }
185    
186    public Long getHeight() {
187        return _value.getHeight();
188    }
189    
190    public void setHeight(Long height)
191            throws PersistenceNotNullException, PersistenceReadOnlyException {
192        checkReadWrite();
193        _value.setHeight(height);
194    }
195    
196    public boolean getHeightHasBeenModified() {
197        return _value.getHeightHasBeenModified();
198    }
199    
200    public Long getWidth() {
201        return _value.getWidth();
202    }
203    
204    public void setWidth(Long width)
205            throws PersistenceNotNullException, PersistenceReadOnlyException {
206        checkReadWrite();
207        _value.setWidth(width);
208    }
209    
210    public boolean getWidthHasBeenModified() {
211        return _value.getWidthHasBeenModified();
212    }
213    
214    public Long getDepth() {
215        return _value.getDepth();
216    }
217    
218    public void setDepth(Long depth)
219            throws PersistenceNotNullException, PersistenceReadOnlyException {
220        checkReadWrite();
221        _value.setDepth(depth);
222    }
223    
224    public boolean getDepthHasBeenModified() {
225        return _value.getDepthHasBeenModified();
226    }
227    
228    public Long getFromTime() {
229        return _value.getFromTime();
230    }
231    
232    public void setFromTime(Long fromTime)
233            throws PersistenceNotNullException, PersistenceReadOnlyException {
234        checkReadWrite();
235        _value.setFromTime(fromTime);
236    }
237    
238    public boolean getFromTimeHasBeenModified() {
239        return _value.getFromTimeHasBeenModified();
240    }
241    
242    public Long getThruTime() {
243        return _value.getThruTime();
244    }
245    
246    public void setThruTime(Long thruTime)
247            throws PersistenceNotNullException, PersistenceReadOnlyException {
248        checkReadWrite();
249        _value.setThruTime(thruTime);
250    }
251    
252    public boolean getThruTimeHasBeenModified() {
253        return _value.getThruTimeHasBeenModified();
254    }
255    
256}