001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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 * NameSuffix.java
021 */
022
023package com.echothree.model.data.party.server.entity;
024
025import com.echothree.model.data.party.common.pk.NameSuffixPK;
026
027import com.echothree.model.data.party.common.pk.NameSuffixDetailPK;
028
029import com.echothree.model.data.party.server.entity.NameSuffixDetail;
030
031import com.echothree.model.data.party.server.factory.NameSuffixDetailFactory;
032
033import com.echothree.model.data.party.common.pk.NameSuffixPK;
034
035import com.echothree.model.data.party.server.value.NameSuffixValue;
036
037import com.echothree.model.data.party.server.factory.NameSuffixFactory;
038
039import com.echothree.util.common.exception.PersistenceException;
040import com.echothree.util.common.exception.PersistenceDatabaseException;
041import com.echothree.util.common.exception.PersistenceNotNullException;
042import com.echothree.util.common.exception.PersistenceReadOnlyException;
043
044import com.echothree.util.common.persistence.BasePK;
045
046import com.echothree.util.common.persistence.type.ByteArray;
047
048import com.echothree.util.server.persistence.BaseEntity;
049import com.echothree.util.server.persistence.EntityPermission;
050import com.echothree.util.server.persistence.Session;
051import com.echothree.util.server.persistence.ThreadSession;
052
053import java.io.Serializable;
054
055public class NameSuffix
056        extends BaseEntity
057        implements Serializable {
058    
059    private NameSuffixPK _pk;
060    private NameSuffixValue _value;
061    
062    /** Creates a new instance of NameSuffix */
063    public NameSuffix()
064            throws PersistenceException {
065        super();
066    }
067    
068    /** Creates a new instance of NameSuffix */
069    public NameSuffix(NameSuffixValue value, EntityPermission entityPermission) {
070        super(entityPermission);
071        
072        _value = value;
073        _pk = value.getPrimaryKey();
074    }
075    
076    @Override
077    public NameSuffixFactory getBaseFactoryInstance() {
078        return NameSuffixFactory.getInstance();
079    }
080    
081    @Override
082    public boolean hasBeenModified() {
083        return _value.hasBeenModified();
084    }
085    
086    @Override
087    public int hashCode() {
088        return _pk.hashCode();
089    }
090    
091    @Override
092    public String toString() {
093        return _pk.toString();
094    }
095    
096    @Override
097    public boolean equals(Object other) {
098        if(this == other)
099            return true;
100        
101        if(other instanceof NameSuffix that) {
102            NameSuffixValue thatValue = that.getNameSuffixValue();
103            return _value.equals(thatValue);
104        } else {
105            return false;
106        }
107    }
108    
109    @Override
110    public void store(Session session)
111            throws PersistenceDatabaseException {
112        getBaseFactoryInstance().store(session, this);
113    }
114    
115    @Override
116    public void remove(Session session)
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().remove(session, this);
119    }
120    
121    @Override
122    public void remove()
123            throws PersistenceDatabaseException {
124        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
125    }
126    
127    public NameSuffixValue getNameSuffixValue() {
128        return _value;
129    }
130    
131    public void setNameSuffixValue(NameSuffixValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    public NameSuffixPK getPrimaryKey() {
139        return _pk;
140    }
141    
142    public NameSuffixDetailPK getActiveDetailPK() {
143        return _value.getActiveDetailPK();
144    }
145    
146    public NameSuffixDetail getActiveDetail(Session session, EntityPermission entityPermission) {
147        NameSuffixDetailPK pk = getActiveDetailPK();
148        NameSuffixDetail entity = pk == null? null: NameSuffixDetailFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
149        
150        return entity;
151    }
152    
153    public NameSuffixDetail getActiveDetail(EntityPermission entityPermission) {
154        return getActiveDetail(ThreadSession.currentSession(), entityPermission);
155    }
156    
157    public NameSuffixDetail getActiveDetail(Session session) {
158        return getActiveDetail(session, EntityPermission.READ_ONLY);
159    }
160    
161    public NameSuffixDetail getActiveDetail() {
162        return getActiveDetail(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
163    }
164    
165    public NameSuffixDetail getActiveDetailForUpdate(Session session) {
166        return getActiveDetail(session, EntityPermission.READ_WRITE);
167    }
168    
169    public NameSuffixDetail getActiveDetailForUpdate() {
170        return getActiveDetail(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
171    }
172    
173    public void setActiveDetailPK(NameSuffixDetailPK activeDetailPK)
174            throws PersistenceNotNullException, PersistenceReadOnlyException {
175        checkReadWrite();
176        _value.setActiveDetailPK(activeDetailPK);
177    }
178    
179    public void setActiveDetail(NameSuffixDetail entity) {
180        setActiveDetailPK(entity == null? null: entity.getPrimaryKey());
181    }
182    
183    public boolean getActiveDetailPKHasBeenModified() {
184        return _value.getActiveDetailPKHasBeenModified();
185    }
186    
187    public NameSuffixDetailPK getLastDetailPK() {
188        return _value.getLastDetailPK();
189    }
190    
191    public NameSuffixDetail getLastDetail(Session session, EntityPermission entityPermission) {
192        NameSuffixDetailPK pk = getLastDetailPK();
193        NameSuffixDetail entity = pk == null? null: NameSuffixDetailFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
194        
195        return entity;
196    }
197    
198    public NameSuffixDetail getLastDetail(EntityPermission entityPermission) {
199        return getLastDetail(ThreadSession.currentSession(), entityPermission);
200    }
201    
202    public NameSuffixDetail getLastDetail(Session session) {
203        return getLastDetail(session, EntityPermission.READ_ONLY);
204    }
205    
206    public NameSuffixDetail getLastDetail() {
207        return getLastDetail(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
208    }
209    
210    public NameSuffixDetail getLastDetailForUpdate(Session session) {
211        return getLastDetail(session, EntityPermission.READ_WRITE);
212    }
213    
214    public NameSuffixDetail getLastDetailForUpdate() {
215        return getLastDetail(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
216    }
217    
218    public void setLastDetailPK(NameSuffixDetailPK lastDetailPK)
219            throws PersistenceNotNullException, PersistenceReadOnlyException {
220        checkReadWrite();
221        _value.setLastDetailPK(lastDetailPK);
222    }
223    
224    public void setLastDetail(NameSuffixDetail entity) {
225        setLastDetailPK(entity == null? null: entity.getPrimaryKey());
226    }
227    
228    public boolean getLastDetailPKHasBeenModified() {
229        return _value.getLastDetailPKHasBeenModified();
230    }
231    
232}