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 * CommunicationEventPurposeDetail.java
021 */
022
023package com.echothree.model.data.communication.server.entity;
024
025import com.echothree.model.data.communication.common.pk.CommunicationEventPurposeDetailPK;
026
027import com.echothree.model.data.communication.common.pk.CommunicationEventPurposePK;
028
029import com.echothree.model.data.communication.server.entity.CommunicationEventPurpose;
030
031import com.echothree.model.data.communication.server.factory.CommunicationEventPurposeFactory;
032
033import com.echothree.model.data.communication.common.pk.CommunicationEventPurposeDetailPK;
034
035import com.echothree.model.data.communication.server.value.CommunicationEventPurposeDetailValue;
036
037import com.echothree.model.data.communication.server.factory.CommunicationEventPurposeDetailFactory;
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 CommunicationEventPurposeDetail
056        extends BaseEntity
057        implements Serializable {
058    
059    private CommunicationEventPurposeDetailPK _pk;
060    private CommunicationEventPurposeDetailValue _value;
061    
062    /** Creates a new instance of CommunicationEventPurposeDetail */
063    public CommunicationEventPurposeDetail()
064            throws PersistenceException {
065        super();
066    }
067    
068    /** Creates a new instance of CommunicationEventPurposeDetail */
069    public CommunicationEventPurposeDetail(CommunicationEventPurposeDetailValue value, EntityPermission entityPermission) {
070        super(entityPermission);
071        
072        _value = value;
073        _pk = value.getPrimaryKey();
074    }
075    
076    @Override
077    public CommunicationEventPurposeDetailFactory getBaseFactoryInstance() {
078        return CommunicationEventPurposeDetailFactory.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 CommunicationEventPurposeDetail that) {
102            CommunicationEventPurposeDetailValue thatValue = that.getCommunicationEventPurposeDetailValue();
103            return _value.equals(thatValue);
104        } else {
105            return false;
106        }
107    }
108    
109    @Override
110    public void store()
111            throws PersistenceDatabaseException {
112        getBaseFactoryInstance().store(this);
113    }
114    
115    @Override
116    public void remove()
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().remove(this);
119    }
120    
121    public CommunicationEventPurposeDetailValue getCommunicationEventPurposeDetailValue() {
122        return _value;
123    }
124    
125    public void setCommunicationEventPurposeDetailValue(CommunicationEventPurposeDetailValue value)
126            throws PersistenceReadOnlyException {
127        checkReadWrite();
128        _value = value;
129    }
130    
131    @Override
132    public CommunicationEventPurposeDetailPK getPrimaryKey() {
133        return _pk;
134    }
135    
136    public CommunicationEventPurposePK getCommunicationEventPurposePK() {
137        return _value.getCommunicationEventPurposePK();
138    }
139    
140    public CommunicationEventPurpose getCommunicationEventPurpose(EntityPermission entityPermission) {
141        return CommunicationEventPurposeFactory.getInstance().getEntityFromPK(entityPermission, getCommunicationEventPurposePK());
142    }
143    
144    public CommunicationEventPurpose getCommunicationEventPurpose() {
145        return getCommunicationEventPurpose(EntityPermission.READ_ONLY);
146    }
147    
148    public CommunicationEventPurpose getCommunicationEventPurposeForUpdate() {
149        return getCommunicationEventPurpose(EntityPermission.READ_WRITE);
150    }
151    
152    public void setCommunicationEventPurposePK(CommunicationEventPurposePK communicationEventPurposePK)
153            throws PersistenceNotNullException, PersistenceReadOnlyException {
154        checkReadWrite();
155        _value.setCommunicationEventPurposePK(communicationEventPurposePK);
156    }
157    
158    public void setCommunicationEventPurpose(CommunicationEventPurpose entity) {
159        setCommunicationEventPurposePK(entity == null? null: entity.getPrimaryKey());
160    }
161    
162    public boolean getCommunicationEventPurposePKHasBeenModified() {
163        return _value.getCommunicationEventPurposePKHasBeenModified();
164    }
165    
166    public String getCommunicationEventPurposeName() {
167        return _value.getCommunicationEventPurposeName();
168    }
169    
170    public void setCommunicationEventPurposeName(String communicationEventPurposeName)
171            throws PersistenceNotNullException, PersistenceReadOnlyException {
172        checkReadWrite();
173        _value.setCommunicationEventPurposeName(communicationEventPurposeName);
174    }
175    
176    public boolean getCommunicationEventPurposeNameHasBeenModified() {
177        return _value.getCommunicationEventPurposeNameHasBeenModified();
178    }
179    
180    public Boolean getIsDefault() {
181        return _value.getIsDefault();
182    }
183    
184    public void setIsDefault(Boolean isDefault)
185            throws PersistenceNotNullException, PersistenceReadOnlyException {
186        checkReadWrite();
187        _value.setIsDefault(isDefault);
188    }
189    
190    public boolean getIsDefaultHasBeenModified() {
191        return _value.getIsDefaultHasBeenModified();
192    }
193    
194    public Integer getSortOrder() {
195        return _value.getSortOrder();
196    }
197    
198    public void setSortOrder(Integer sortOrder)
199            throws PersistenceNotNullException, PersistenceReadOnlyException {
200        checkReadWrite();
201        _value.setSortOrder(sortOrder);
202    }
203    
204    public boolean getSortOrderHasBeenModified() {
205        return _value.getSortOrderHasBeenModified();
206    }
207    
208    public Long getFromTime() {
209        return _value.getFromTime();
210    }
211    
212    public void setFromTime(Long fromTime)
213            throws PersistenceNotNullException, PersistenceReadOnlyException {
214        checkReadWrite();
215        _value.setFromTime(fromTime);
216    }
217    
218    public boolean getFromTimeHasBeenModified() {
219        return _value.getFromTimeHasBeenModified();
220    }
221    
222    public Long getThruTime() {
223        return _value.getThruTime();
224    }
225    
226    public void setThruTime(Long thruTime)
227            throws PersistenceNotNullException, PersistenceReadOnlyException {
228        checkReadWrite();
229        _value.setThruTime(thruTime);
230    }
231    
232    public boolean getThruTimeHasBeenModified() {
233        return _value.getThruTimeHasBeenModified();
234    }
235    
236}