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 * PartyScaleUse.java
021 */
022
023package com.echothree.model.data.scale.server.entity;
024
025import com.echothree.model.data.scale.common.pk.PartyScaleUsePK;
026
027import com.echothree.model.data.party.common.pk.PartyPK;
028import com.echothree.model.data.scale.common.pk.ScaleUseTypePK;
029import com.echothree.model.data.scale.common.pk.ScalePK;
030
031import com.echothree.model.data.party.server.entity.Party;
032import com.echothree.model.data.scale.server.entity.ScaleUseType;
033import com.echothree.model.data.scale.server.entity.Scale;
034
035import com.echothree.model.data.party.server.factory.PartyFactory;
036import com.echothree.model.data.scale.server.factory.ScaleUseTypeFactory;
037import com.echothree.model.data.scale.server.factory.ScaleFactory;
038
039import com.echothree.model.data.scale.common.pk.PartyScaleUsePK;
040
041import com.echothree.model.data.scale.server.value.PartyScaleUseValue;
042
043import com.echothree.model.data.scale.server.factory.PartyScaleUseFactory;
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
061import javax.annotation.Nonnull;
062import javax.annotation.Nullable;
063
064public class PartyScaleUse
065        extends BaseEntity
066        implements Serializable {
067    
068    private PartyScaleUsePK _pk;
069    private PartyScaleUseValue _value;
070    
071    /** Creates a new instance of PartyScaleUse */
072    public PartyScaleUse()
073            throws PersistenceException {
074        super();
075    }
076    
077    /** Creates a new instance of PartyScaleUse */
078    public PartyScaleUse(PartyScaleUseValue value, EntityPermission entityPermission) {
079        super(entityPermission);
080        
081        _value = value;
082        _pk = value.getPrimaryKey();
083    }
084    
085    @Override
086    @Nonnull
087    public PartyScaleUseFactory getBaseFactoryInstance() {
088        return PartyScaleUseFactory.getInstance();
089    }
090    
091    @Override
092    public boolean hasBeenModified() {
093        return _value.hasBeenModified();
094    }
095    
096    @Override
097    public int hashCode() {
098        return _pk.hashCode();
099    }
100    
101    @Override
102    @Nonnull
103    public String toString() {
104        return _pk.toString();
105    }
106    
107    @Override
108    public boolean equals(Object other) {
109        if(this == other)
110            return true;
111        
112        if(other instanceof PartyScaleUse that) {
113            PartyScaleUseValue thatValue = that.getPartyScaleUseValue();
114            return _value.equals(thatValue);
115        } else {
116            return false;
117        }
118    }
119    
120    @Override
121    public void store()
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().store(this);
124    }
125    
126    @Override
127    public void remove()
128            throws PersistenceDatabaseException {
129        getBaseFactoryInstance().remove(this);
130    }
131    
132    @Nonnull
133    public PartyScaleUseValue getPartyScaleUseValue() {
134        return _value;
135    }
136    
137    public void setPartyScaleUseValue(@Nonnull PartyScaleUseValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    @Nonnull
145    public PartyScaleUsePK getPrimaryKey() {
146        return _pk;
147    }
148    
149    @Nonnull
150    public PartyPK getPartyPK() {
151        return _value.getPartyPK();
152    }
153    
154    @Nonnull
155    public Party getParty(EntityPermission entityPermission) {
156        return PartyFactory.getInstance().getEntityFromPK(entityPermission, getPartyPK());
157    }
158    
159    @Nonnull
160    public Party getParty() {
161        return getParty(EntityPermission.READ_ONLY);
162    }
163    
164    @Nonnull
165    public Party getPartyForUpdate() {
166        return getParty(EntityPermission.READ_WRITE);
167    }
168    
169    public void setPartyPK(@Nonnull PartyPK partyPK)
170            throws PersistenceNotNullException, PersistenceReadOnlyException {
171        checkReadWrite();
172        _value.setPartyPK(partyPK);
173    }
174    
175    public void setParty(@Nonnull Party entity) {
176        setPartyPK(entity == null ? null : entity.getPrimaryKey());
177    }
178    
179    public boolean getPartyPKHasBeenModified() {
180        return _value.getPartyPKHasBeenModified();
181    }
182    
183    @Nonnull
184    public ScaleUseTypePK getScaleUseTypePK() {
185        return _value.getScaleUseTypePK();
186    }
187    
188    @Nonnull
189    public ScaleUseType getScaleUseType(EntityPermission entityPermission) {
190        return ScaleUseTypeFactory.getInstance().getEntityFromPK(entityPermission, getScaleUseTypePK());
191    }
192    
193    @Nonnull
194    public ScaleUseType getScaleUseType() {
195        return getScaleUseType(EntityPermission.READ_ONLY);
196    }
197    
198    @Nonnull
199    public ScaleUseType getScaleUseTypeForUpdate() {
200        return getScaleUseType(EntityPermission.READ_WRITE);
201    }
202    
203    public void setScaleUseTypePK(@Nonnull ScaleUseTypePK scaleUseTypePK)
204            throws PersistenceNotNullException, PersistenceReadOnlyException {
205        checkReadWrite();
206        _value.setScaleUseTypePK(scaleUseTypePK);
207    }
208    
209    public void setScaleUseType(@Nonnull ScaleUseType entity) {
210        setScaleUseTypePK(entity == null ? null : entity.getPrimaryKey());
211    }
212    
213    public boolean getScaleUseTypePKHasBeenModified() {
214        return _value.getScaleUseTypePKHasBeenModified();
215    }
216    
217    @Nonnull
218    public ScalePK getScalePK() {
219        return _value.getScalePK();
220    }
221    
222    @Nonnull
223    public Scale getScale(EntityPermission entityPermission) {
224        return ScaleFactory.getInstance().getEntityFromPK(entityPermission, getScalePK());
225    }
226    
227    @Nonnull
228    public Scale getScale() {
229        return getScale(EntityPermission.READ_ONLY);
230    }
231    
232    @Nonnull
233    public Scale getScaleForUpdate() {
234        return getScale(EntityPermission.READ_WRITE);
235    }
236    
237    public void setScalePK(@Nonnull ScalePK scalePK)
238            throws PersistenceNotNullException, PersistenceReadOnlyException {
239        checkReadWrite();
240        _value.setScalePK(scalePK);
241    }
242    
243    public void setScale(@Nonnull Scale entity) {
244        setScalePK(entity == null ? null : entity.getPrimaryKey());
245    }
246    
247    public boolean getScalePKHasBeenModified() {
248        return _value.getScalePKHasBeenModified();
249    }
250    
251    @Nonnull
252    public Long getFromTime() {
253        return _value.getFromTime();
254    }
255    
256    public void setFromTime(@Nonnull Long fromTime)
257            throws PersistenceNotNullException, PersistenceReadOnlyException {
258        checkReadWrite();
259        _value.setFromTime(fromTime);
260    }
261    
262    public boolean getFromTimeHasBeenModified() {
263        return _value.getFromTimeHasBeenModified();
264    }
265    
266    @Nonnull
267    public Long getThruTime() {
268        return _value.getThruTime();
269    }
270    
271    public void setThruTime(@Nonnull Long thruTime)
272            throws PersistenceNotNullException, PersistenceReadOnlyException {
273        checkReadWrite();
274        _value.setThruTime(thruTime);
275    }
276    
277    public boolean getThruTimeHasBeenModified() {
278        return _value.getThruTimeHasBeenModified();
279    }
280    
281}