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 * ChainDetail.java
021 */
022
023package com.echothree.model.data.chain.server.entity;
024
025import com.echothree.model.data.chain.common.pk.ChainDetailPK;
026
027import com.echothree.model.data.chain.common.pk.ChainPK;
028import com.echothree.model.data.chain.common.pk.ChainTypePK;
029import com.echothree.model.data.sequence.common.pk.SequencePK;
030
031import com.echothree.model.data.chain.server.entity.Chain;
032import com.echothree.model.data.chain.server.entity.ChainType;
033import com.echothree.model.data.sequence.server.entity.Sequence;
034
035import com.echothree.model.data.chain.server.factory.ChainFactory;
036import com.echothree.model.data.chain.server.factory.ChainTypeFactory;
037import com.echothree.model.data.sequence.server.factory.SequenceFactory;
038
039import com.echothree.model.data.chain.common.pk.ChainDetailPK;
040
041import com.echothree.model.data.chain.server.value.ChainDetailValue;
042
043import com.echothree.model.data.chain.server.factory.ChainDetailFactory;
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 ChainDetail
065        extends BaseEntity
066        implements Serializable {
067    
068    private ChainDetailPK _pk;
069    private ChainDetailValue _value;
070    
071    /** Creates a new instance of ChainDetail */
072    public ChainDetail()
073            throws PersistenceException {
074        super();
075    }
076    
077    /** Creates a new instance of ChainDetail */
078    public ChainDetail(ChainDetailValue value, EntityPermission entityPermission) {
079        super(entityPermission);
080        
081        _value = value;
082        _pk = value.getPrimaryKey();
083    }
084    
085    @Override
086    @Nonnull
087    public ChainDetailFactory getBaseFactoryInstance() {
088        return ChainDetailFactory.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 ChainDetail that) {
113            ChainDetailValue thatValue = that.getChainDetailValue();
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 ChainDetailValue getChainDetailValue() {
134        return _value;
135    }
136    
137    public void setChainDetailValue(@Nonnull ChainDetailValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    @Nonnull
145    public ChainDetailPK getPrimaryKey() {
146        return _pk;
147    }
148    
149    @Nonnull
150    public ChainPK getChainPK() {
151        return _value.getChainPK();
152    }
153    
154    @Nonnull
155    public Chain getChain(EntityPermission entityPermission) {
156        return ChainFactory.getInstance().getEntityFromPK(entityPermission, getChainPK());
157    }
158    
159    @Nonnull
160    public Chain getChain() {
161        return getChain(EntityPermission.READ_ONLY);
162    }
163    
164    @Nonnull
165    public Chain getChainForUpdate() {
166        return getChain(EntityPermission.READ_WRITE);
167    }
168    
169    public void setChainPK(@Nonnull ChainPK chainPK)
170            throws PersistenceNotNullException, PersistenceReadOnlyException {
171        checkReadWrite();
172        _value.setChainPK(chainPK);
173    }
174    
175    public void setChain(@Nonnull Chain entity) {
176        setChainPK(entity == null ? null : entity.getPrimaryKey());
177    }
178    
179    public boolean getChainPKHasBeenModified() {
180        return _value.getChainPKHasBeenModified();
181    }
182    
183    @Nonnull
184    public ChainTypePK getChainTypePK() {
185        return _value.getChainTypePK();
186    }
187    
188    @Nonnull
189    public ChainType getChainType(EntityPermission entityPermission) {
190        return ChainTypeFactory.getInstance().getEntityFromPK(entityPermission, getChainTypePK());
191    }
192    
193    @Nonnull
194    public ChainType getChainType() {
195        return getChainType(EntityPermission.READ_ONLY);
196    }
197    
198    @Nonnull
199    public ChainType getChainTypeForUpdate() {
200        return getChainType(EntityPermission.READ_WRITE);
201    }
202    
203    public void setChainTypePK(@Nonnull ChainTypePK chainTypePK)
204            throws PersistenceNotNullException, PersistenceReadOnlyException {
205        checkReadWrite();
206        _value.setChainTypePK(chainTypePK);
207    }
208    
209    public void setChainType(@Nonnull ChainType entity) {
210        setChainTypePK(entity == null ? null : entity.getPrimaryKey());
211    }
212    
213    public boolean getChainTypePKHasBeenModified() {
214        return _value.getChainTypePKHasBeenModified();
215    }
216    
217    @Nonnull
218    public String getChainName() {
219        return _value.getChainName();
220    }
221    
222    public void setChainName(@Nonnull String chainName)
223            throws PersistenceNotNullException, PersistenceReadOnlyException {
224        checkReadWrite();
225        _value.setChainName(chainName);
226    }
227    
228    public boolean getChainNameHasBeenModified() {
229        return _value.getChainNameHasBeenModified();
230    }
231    
232    @Nullable
233    public SequencePK getChainInstanceSequencePK() {
234        return _value.getChainInstanceSequencePK();
235    }
236    
237    @Nullable
238    public Sequence getChainInstanceSequence(EntityPermission entityPermission) {
239        SequencePK pk = getChainInstanceSequencePK();
240        Sequence entity = pk == null? null: SequenceFactory.getInstance().getEntityFromPK(entityPermission, pk);
241        
242        return entity;
243    }
244    
245    @Nullable
246    public Sequence getChainInstanceSequence() {
247        return getChainInstanceSequence(EntityPermission.READ_ONLY);
248    }
249    
250    @Nullable
251    public Sequence getChainInstanceSequenceForUpdate() {
252        return getChainInstanceSequence(EntityPermission.READ_WRITE);
253    }
254    
255    public void setChainInstanceSequencePK(@Nullable SequencePK chainInstanceSequencePK)
256            throws PersistenceNotNullException, PersistenceReadOnlyException {
257        checkReadWrite();
258        _value.setChainInstanceSequencePK(chainInstanceSequencePK);
259    }
260    
261    public void setChainInstanceSequence(@Nullable Sequence entity) {
262        setChainInstanceSequencePK(entity == null ? null : entity.getPrimaryKey());
263    }
264    
265    public boolean getChainInstanceSequencePKHasBeenModified() {
266        return _value.getChainInstanceSequencePKHasBeenModified();
267    }
268    
269    @Nonnull
270    public Boolean getIsDefault() {
271        return _value.getIsDefault();
272    }
273    
274    public void setIsDefault(@Nonnull Boolean isDefault)
275            throws PersistenceNotNullException, PersistenceReadOnlyException {
276        checkReadWrite();
277        _value.setIsDefault(isDefault);
278    }
279    
280    public boolean getIsDefaultHasBeenModified() {
281        return _value.getIsDefaultHasBeenModified();
282    }
283    
284    @Nonnull
285    public Integer getSortOrder() {
286        return _value.getSortOrder();
287    }
288    
289    public void setSortOrder(@Nonnull Integer sortOrder)
290            throws PersistenceNotNullException, PersistenceReadOnlyException {
291        checkReadWrite();
292        _value.setSortOrder(sortOrder);
293    }
294    
295    public boolean getSortOrderHasBeenModified() {
296        return _value.getSortOrderHasBeenModified();
297    }
298    
299    @Nonnull
300    public Long getFromTime() {
301        return _value.getFromTime();
302    }
303    
304    public void setFromTime(@Nonnull Long fromTime)
305            throws PersistenceNotNullException, PersistenceReadOnlyException {
306        checkReadWrite();
307        _value.setFromTime(fromTime);
308    }
309    
310    public boolean getFromTimeHasBeenModified() {
311        return _value.getFromTimeHasBeenModified();
312    }
313    
314    @Nonnull
315    public Long getThruTime() {
316        return _value.getThruTime();
317    }
318    
319    public void setThruTime(@Nonnull Long thruTime)
320            throws PersistenceNotNullException, PersistenceReadOnlyException {
321        checkReadWrite();
322        _value.setThruTime(thruTime);
323    }
324    
325    public boolean getThruTimeHasBeenModified() {
326        return _value.getThruTimeHasBeenModified();
327    }
328    
329}