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 * 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) {
105            QueuedLetter that = (QueuedLetter)other;
106            
107            QueuedLetterValue thatValue = that.getQueuedLetterValue();
108            return _value.equals(thatValue);
109        } else {
110            return false;
111        }
112    }
113    
114    @Override
115    public void store(Session session)
116            throws PersistenceDatabaseException {
117        getBaseFactoryInstance().store(session, this);
118    }
119    
120    @Override
121    public void remove(Session session)
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().remove(session, this);
124    }
125    
126    @Override
127    public void remove()
128            throws PersistenceDatabaseException {
129        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
130    }
131    
132    public QueuedLetterValue getQueuedLetterValue() {
133        return _value;
134    }
135    
136    public void setQueuedLetterValue(QueuedLetterValue value)
137            throws PersistenceReadOnlyException {
138        checkReadWrite();
139        _value = value;
140    }
141    
142    @Override
143    public QueuedLetterPK getPrimaryKey() {
144        return _pk;
145    }
146    
147    public ChainInstancePK getChainInstancePK() {
148        return _value.getChainInstancePK();
149    }
150    
151    public ChainInstance getChainInstance(Session session, EntityPermission entityPermission) {
152        return ChainInstanceFactory.getInstance().getEntityFromPK(session, entityPermission, getChainInstancePK());
153    }
154    
155    public ChainInstance getChainInstance(EntityPermission entityPermission) {
156        return getChainInstance(ThreadSession.currentSession(), entityPermission);
157    }
158    
159    public ChainInstance getChainInstance(Session session) {
160        return getChainInstance(session, EntityPermission.READ_ONLY);
161    }
162    
163    public ChainInstance getChainInstance() {
164        return getChainInstance(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
165    }
166    
167    public ChainInstance getChainInstanceForUpdate(Session session) {
168        return getChainInstance(session, EntityPermission.READ_WRITE);
169    }
170    
171    public ChainInstance getChainInstanceForUpdate() {
172        return getChainInstance(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
173    }
174    
175    public void setChainInstancePK(ChainInstancePK chainInstancePK)
176            throws PersistenceNotNullException, PersistenceReadOnlyException {
177        checkReadWrite();
178        _value.setChainInstancePK(chainInstancePK);
179    }
180    
181    public void setChainInstance(ChainInstance entity) {
182        setChainInstancePK(entity == null? null: entity.getPrimaryKey());
183    }
184    
185    public boolean getChainInstancePKHasBeenModified() {
186        return _value.getChainInstancePKHasBeenModified();
187    }
188    
189    public Integer getQueuedLetterSequence() {
190        return _value.getQueuedLetterSequence();
191    }
192    
193    public void setQueuedLetterSequence(Integer queuedLetterSequence)
194            throws PersistenceNotNullException, PersistenceReadOnlyException {
195        checkReadWrite();
196        _value.setQueuedLetterSequence(queuedLetterSequence);
197    }
198    
199    public boolean getQueuedLetterSequenceHasBeenModified() {
200        return _value.getQueuedLetterSequenceHasBeenModified();
201    }
202    
203    public LetterPK getLetterPK() {
204        return _value.getLetterPK();
205    }
206    
207    public Letter getLetter(Session session, EntityPermission entityPermission) {
208        return LetterFactory.getInstance().getEntityFromPK(session, entityPermission, getLetterPK());
209    }
210    
211    public Letter getLetter(EntityPermission entityPermission) {
212        return getLetter(ThreadSession.currentSession(), entityPermission);
213    }
214    
215    public Letter getLetter(Session session) {
216        return getLetter(session, EntityPermission.READ_ONLY);
217    }
218    
219    public Letter getLetter() {
220        return getLetter(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
221    }
222    
223    public Letter getLetterForUpdate(Session session) {
224        return getLetter(session, EntityPermission.READ_WRITE);
225    }
226    
227    public Letter getLetterForUpdate() {
228        return getLetter(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
229    }
230    
231    public void setLetterPK(LetterPK letterPK)
232            throws PersistenceNotNullException, PersistenceReadOnlyException {
233        checkReadWrite();
234        _value.setLetterPK(letterPK);
235    }
236    
237    public void setLetter(Letter entity) {
238        setLetterPK(entity == null? null: entity.getPrimaryKey());
239    }
240    
241    public boolean getLetterPKHasBeenModified() {
242        return _value.getLetterPKHasBeenModified();
243    }
244    
245}