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 * OfferUseDetail.java
021 */
022
023package com.echothree.model.data.offer.server.entity;
024
025import com.echothree.model.data.offer.common.pk.OfferUseDetailPK;
026
027import com.echothree.model.data.offer.common.pk.OfferUsePK;
028import com.echothree.model.data.offer.common.pk.OfferPK;
029import com.echothree.model.data.offer.common.pk.UsePK;
030import com.echothree.model.data.sequence.common.pk.SequencePK;
031
032import com.echothree.model.data.offer.server.entity.OfferUse;
033import com.echothree.model.data.offer.server.entity.Offer;
034import com.echothree.model.data.offer.server.entity.Use;
035import com.echothree.model.data.sequence.server.entity.Sequence;
036
037import com.echothree.model.data.offer.server.factory.OfferUseFactory;
038import com.echothree.model.data.offer.server.factory.OfferFactory;
039import com.echothree.model.data.offer.server.factory.UseFactory;
040import com.echothree.model.data.sequence.server.factory.SequenceFactory;
041
042import com.echothree.model.data.offer.common.pk.OfferUseDetailPK;
043
044import com.echothree.model.data.offer.server.value.OfferUseDetailValue;
045
046import com.echothree.model.data.offer.server.factory.OfferUseDetailFactory;
047
048import com.echothree.util.common.exception.PersistenceException;
049import com.echothree.util.common.exception.PersistenceDatabaseException;
050import com.echothree.util.common.exception.PersistenceNotNullException;
051import com.echothree.util.common.exception.PersistenceReadOnlyException;
052
053import com.echothree.util.common.persistence.BasePK;
054
055import com.echothree.util.common.persistence.type.ByteArray;
056
057import com.echothree.util.server.persistence.BaseEntity;
058import com.echothree.util.server.persistence.EntityPermission;
059import com.echothree.util.server.persistence.Session;
060import com.echothree.util.server.persistence.ThreadSession;
061
062import java.io.Serializable;
063
064import javax.annotation.Nonnull;
065import javax.annotation.Nullable;
066
067public class OfferUseDetail
068        extends BaseEntity
069        implements Serializable {
070    
071    private OfferUseDetailPK _pk;
072    private OfferUseDetailValue _value;
073    
074    /** Creates a new instance of OfferUseDetail */
075    public OfferUseDetail()
076            throws PersistenceException {
077        super();
078    }
079    
080    /** Creates a new instance of OfferUseDetail */
081    public OfferUseDetail(OfferUseDetailValue value, EntityPermission entityPermission) {
082        super(entityPermission);
083        
084        _value = value;
085        _pk = value.getPrimaryKey();
086    }
087    
088    @Override
089    @Nonnull
090    public OfferUseDetailFactory getBaseFactoryInstance() {
091        return OfferUseDetailFactory.getInstance();
092    }
093    
094    @Override
095    public boolean hasBeenModified() {
096        return _value.hasBeenModified();
097    }
098    
099    @Override
100    public int hashCode() {
101        return _pk.hashCode();
102    }
103    
104    @Override
105    @Nonnull
106    public String toString() {
107        return _pk.toString();
108    }
109    
110    @Override
111    public boolean equals(Object other) {
112        if(this == other)
113            return true;
114        
115        if(other instanceof OfferUseDetail that) {
116            OfferUseDetailValue thatValue = that.getOfferUseDetailValue();
117            return _value.equals(thatValue);
118        } else {
119            return false;
120        }
121    }
122    
123    @Override
124    public void store()
125            throws PersistenceDatabaseException {
126        getBaseFactoryInstance().store(this);
127    }
128    
129    @Override
130    public void remove()
131            throws PersistenceDatabaseException {
132        getBaseFactoryInstance().remove(this);
133    }
134    
135    @Nonnull
136    public OfferUseDetailValue getOfferUseDetailValue() {
137        return _value;
138    }
139    
140    public void setOfferUseDetailValue(@Nonnull OfferUseDetailValue value)
141            throws PersistenceReadOnlyException {
142        checkReadWrite();
143        _value = value;
144    }
145    
146    @Override
147    @Nonnull
148    public OfferUseDetailPK getPrimaryKey() {
149        return _pk;
150    }
151    
152    @Nonnull
153    public OfferUsePK getOfferUsePK() {
154        return _value.getOfferUsePK();
155    }
156    
157    @Nonnull
158    public OfferUse getOfferUse(EntityPermission entityPermission) {
159        return OfferUseFactory.getInstance().getEntityFromPK(entityPermission, getOfferUsePK());
160    }
161    
162    @Nonnull
163    public OfferUse getOfferUse() {
164        return getOfferUse(EntityPermission.READ_ONLY);
165    }
166    
167    @Nonnull
168    public OfferUse getOfferUseForUpdate() {
169        return getOfferUse(EntityPermission.READ_WRITE);
170    }
171    
172    public void setOfferUsePK(@Nonnull OfferUsePK offerUsePK)
173            throws PersistenceNotNullException, PersistenceReadOnlyException {
174        checkReadWrite();
175        _value.setOfferUsePK(offerUsePK);
176    }
177    
178    public void setOfferUse(@Nonnull OfferUse entity) {
179        setOfferUsePK(entity == null ? null : entity.getPrimaryKey());
180    }
181    
182    public boolean getOfferUsePKHasBeenModified() {
183        return _value.getOfferUsePKHasBeenModified();
184    }
185    
186    @Nonnull
187    public OfferPK getOfferPK() {
188        return _value.getOfferPK();
189    }
190    
191    @Nonnull
192    public Offer getOffer(EntityPermission entityPermission) {
193        return OfferFactory.getInstance().getEntityFromPK(entityPermission, getOfferPK());
194    }
195    
196    @Nonnull
197    public Offer getOffer() {
198        return getOffer(EntityPermission.READ_ONLY);
199    }
200    
201    @Nonnull
202    public Offer getOfferForUpdate() {
203        return getOffer(EntityPermission.READ_WRITE);
204    }
205    
206    public void setOfferPK(@Nonnull OfferPK offerPK)
207            throws PersistenceNotNullException, PersistenceReadOnlyException {
208        checkReadWrite();
209        _value.setOfferPK(offerPK);
210    }
211    
212    public void setOffer(@Nonnull Offer entity) {
213        setOfferPK(entity == null ? null : entity.getPrimaryKey());
214    }
215    
216    public boolean getOfferPKHasBeenModified() {
217        return _value.getOfferPKHasBeenModified();
218    }
219    
220    @Nonnull
221    public UsePK getUsePK() {
222        return _value.getUsePK();
223    }
224    
225    @Nonnull
226    public Use getUse(EntityPermission entityPermission) {
227        return UseFactory.getInstance().getEntityFromPK(entityPermission, getUsePK());
228    }
229    
230    @Nonnull
231    public Use getUse() {
232        return getUse(EntityPermission.READ_ONLY);
233    }
234    
235    @Nonnull
236    public Use getUseForUpdate() {
237        return getUse(EntityPermission.READ_WRITE);
238    }
239    
240    public void setUsePK(@Nonnull UsePK usePK)
241            throws PersistenceNotNullException, PersistenceReadOnlyException {
242        checkReadWrite();
243        _value.setUsePK(usePK);
244    }
245    
246    public void setUse(@Nonnull Use entity) {
247        setUsePK(entity == null ? null : entity.getPrimaryKey());
248    }
249    
250    public boolean getUsePKHasBeenModified() {
251        return _value.getUsePKHasBeenModified();
252    }
253    
254    @Nullable
255    public SequencePK getSalesOrderSequencePK() {
256        return _value.getSalesOrderSequencePK();
257    }
258    
259    @Nullable
260    public Sequence getSalesOrderSequence(EntityPermission entityPermission) {
261        SequencePK pk = getSalesOrderSequencePK();
262        Sequence entity = pk == null? null: SequenceFactory.getInstance().getEntityFromPK(entityPermission, pk);
263        
264        return entity;
265    }
266    
267    @Nullable
268    public Sequence getSalesOrderSequence() {
269        return getSalesOrderSequence(EntityPermission.READ_ONLY);
270    }
271    
272    @Nullable
273    public Sequence getSalesOrderSequenceForUpdate() {
274        return getSalesOrderSequence(EntityPermission.READ_WRITE);
275    }
276    
277    public void setSalesOrderSequencePK(@Nullable SequencePK salesOrderSequencePK)
278            throws PersistenceNotNullException, PersistenceReadOnlyException {
279        checkReadWrite();
280        _value.setSalesOrderSequencePK(salesOrderSequencePK);
281    }
282    
283    public void setSalesOrderSequence(@Nullable Sequence entity) {
284        setSalesOrderSequencePK(entity == null ? null : entity.getPrimaryKey());
285    }
286    
287    public boolean getSalesOrderSequencePKHasBeenModified() {
288        return _value.getSalesOrderSequencePKHasBeenModified();
289    }
290    
291    @Nonnull
292    public Long getFromTime() {
293        return _value.getFromTime();
294    }
295    
296    public void setFromTime(@Nonnull Long fromTime)
297            throws PersistenceNotNullException, PersistenceReadOnlyException {
298        checkReadWrite();
299        _value.setFromTime(fromTime);
300    }
301    
302    public boolean getFromTimeHasBeenModified() {
303        return _value.getFromTimeHasBeenModified();
304    }
305    
306    @Nonnull
307    public Long getThruTime() {
308        return _value.getThruTime();
309    }
310    
311    public void setThruTime(@Nonnull Long thruTime)
312            throws PersistenceNotNullException, PersistenceReadOnlyException {
313        checkReadWrite();
314        _value.setThruTime(thruTime);
315    }
316    
317    public boolean getThruTimeHasBeenModified() {
318        return _value.getThruTimeHasBeenModified();
319    }
320    
321}