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 * QueuedLetter.java
021 */
022
023package com.echothree.model.data.letter.server.entity;
024
025import com.echothree.model.data.letter.common.pk.QueuedLetterPK;
026
027import com.echothree.model.data.chain.common.pk.ChainInstancePK;
028import com.echothree.model.data.letter.common.pk.LetterPK;
029
030import com.echothree.model.data.chain.server.entity.ChainInstance;
031import com.echothree.model.data.letter.server.entity.Letter;
032
033import com.echothree.model.data.chain.server.factory.ChainInstanceFactory;
034import com.echothree.model.data.letter.server.factory.LetterFactory;
035
036import com.echothree.model.data.letter.common.pk.QueuedLetterPK;
037
038import com.echothree.model.data.letter.server.value.QueuedLetterValue;
039
040import com.echothree.model.data.letter.server.factory.QueuedLetterFactory;
041
042import com.echothree.util.common.exception.PersistenceException;
043import com.echothree.util.common.exception.PersistenceDatabaseException;
044import com.echothree.util.common.exception.PersistenceNotNullException;
045import com.echothree.util.common.exception.PersistenceReadOnlyException;
046
047import com.echothree.util.common.persistence.BasePK;
048
049import com.echothree.util.common.persistence.type.ByteArray;
050
051import com.echothree.util.server.persistence.BaseEntity;
052import com.echothree.util.server.persistence.EntityPermission;
053import com.echothree.util.server.persistence.Session;
054import com.echothree.util.server.persistence.ThreadSession;
055
056import java.io.Serializable;
057
058public class QueuedLetter
059        extends BaseEntity
060        implements Serializable {
061    
062    private QueuedLetterPK _pk;
063    private QueuedLetterValue _value;
064    
065    /** Creates a new instance of QueuedLetter */
066    public QueuedLetter()
067            throws PersistenceException {
068        super();
069    }
070    
071    /** Creates a new instance of QueuedLetter */
072    public QueuedLetter(QueuedLetterValue value, EntityPermission entityPermission) {
073        super(entityPermission);
074        
075        _value = value;
076        _pk = value.getPrimaryKey();
077    }
078    
079    @Override
080    public QueuedLetterFactory getBaseFactoryInstance() {
081        return QueuedLetterFactory.getInstance();
082    }
083    
084    @Override
085    public boolean hasBeenModified() {
086        return _value.hasBeenModified();
087    }
088    
089    @Override
090    public int hashCode() {
091        return _pk.hashCode();
092    }
093    
094    @Override
095    public String toString() {
096        return _pk.toString();
097    }
098    
099    @Override
100    public boolean equals(Object other) {
101        if(this == other)
102            return true;
103        
104        if(other instanceof QueuedLetter that) {
105            QueuedLetterValue thatValue = that.getQueuedLetterValue();
106            return _value.equals(thatValue);
107        } else {
108            return false;
109        }
110    }
111    
112    @Override
113    public void store()
114            throws PersistenceDatabaseException {
115        getBaseFactoryInstance().store(this);
116    }
117    
118    @Override
119    public void remove()
120            throws PersistenceDatabaseException {
121        getBaseFactoryInstance().remove(this);
122    }
123    
124    public QueuedLetterValue getQueuedLetterValue() {
125        return _value;
126    }
127    
128    public void setQueuedLetterValue(QueuedLetterValue value)
129            throws PersistenceReadOnlyException {
130        checkReadWrite();
131        _value = value;
132    }
133    
134    @Override
135    public QueuedLetterPK getPrimaryKey() {
136        return _pk;
137    }
138    
139    public ChainInstancePK getChainInstancePK() {
140        return _value.getChainInstancePK();
141    }
142    
143    public ChainInstance getChainInstance(EntityPermission entityPermission) {
144        return ChainInstanceFactory.getInstance().getEntityFromPK(entityPermission, getChainInstancePK());
145    }
146    
147    public ChainInstance getChainInstance() {
148        return getChainInstance(EntityPermission.READ_ONLY);
149    }
150    
151    public ChainInstance getChainInstanceForUpdate() {
152        return getChainInstance(EntityPermission.READ_WRITE);
153    }
154    
155    public void setChainInstancePK(ChainInstancePK chainInstancePK)
156            throws PersistenceNotNullException, PersistenceReadOnlyException {
157        checkReadWrite();
158        _value.setChainInstancePK(chainInstancePK);
159    }
160    
161    public void setChainInstance(ChainInstance entity) {
162        setChainInstancePK(entity == null? null: entity.getPrimaryKey());
163    }
164    
165    public boolean getChainInstancePKHasBeenModified() {
166        return _value.getChainInstancePKHasBeenModified();
167    }
168    
169    public Integer getQueuedLetterSequence() {
170        return _value.getQueuedLetterSequence();
171    }
172    
173    public void setQueuedLetterSequence(Integer queuedLetterSequence)
174            throws PersistenceNotNullException, PersistenceReadOnlyException {
175        checkReadWrite();
176        _value.setQueuedLetterSequence(queuedLetterSequence);
177    }
178    
179    public boolean getQueuedLetterSequenceHasBeenModified() {
180        return _value.getQueuedLetterSequenceHasBeenModified();
181    }
182    
183    public LetterPK getLetterPK() {
184        return _value.getLetterPK();
185    }
186    
187    public Letter getLetter(EntityPermission entityPermission) {
188        return LetterFactory.getInstance().getEntityFromPK(entityPermission, getLetterPK());
189    }
190    
191    public Letter getLetter() {
192        return getLetter(EntityPermission.READ_ONLY);
193    }
194    
195    public Letter getLetterForUpdate() {
196        return getLetter(EntityPermission.READ_WRITE);
197    }
198    
199    public void setLetterPK(LetterPK letterPK)
200            throws PersistenceNotNullException, PersistenceReadOnlyException {
201        checkReadWrite();
202        _value.setLetterPK(letterPK);
203    }
204    
205    public void setLetter(Letter entity) {
206        setLetterPK(entity == null? null: entity.getPrimaryKey());
207    }
208    
209    public boolean getLetterPKHasBeenModified() {
210        return _value.getLetterPKHasBeenModified();
211    }
212    
213}