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 * CommunicationSourceDetail.java
021 */
022
023package com.echothree.model.data.communication.server.entity;
024
025import com.echothree.model.data.communication.common.pk.CommunicationSourceDetailPK;
026
027import com.echothree.model.data.communication.common.pk.CommunicationSourcePK;
028import com.echothree.model.data.communication.common.pk.CommunicationSourceTypePK;
029
030import com.echothree.model.data.communication.server.entity.CommunicationSource;
031import com.echothree.model.data.communication.server.entity.CommunicationSourceType;
032
033import com.echothree.model.data.communication.server.factory.CommunicationSourceFactory;
034import com.echothree.model.data.communication.server.factory.CommunicationSourceTypeFactory;
035
036import com.echothree.model.data.communication.common.pk.CommunicationSourceDetailPK;
037
038import com.echothree.model.data.communication.server.value.CommunicationSourceDetailValue;
039
040import com.echothree.model.data.communication.server.factory.CommunicationSourceDetailFactory;
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 CommunicationSourceDetail
059        extends BaseEntity
060        implements Serializable {
061    
062    private CommunicationSourceDetailPK _pk;
063    private CommunicationSourceDetailValue _value;
064    
065    /** Creates a new instance of CommunicationSourceDetail */
066    public CommunicationSourceDetail()
067            throws PersistenceException {
068        super();
069    }
070    
071    /** Creates a new instance of CommunicationSourceDetail */
072    public CommunicationSourceDetail(CommunicationSourceDetailValue value, EntityPermission entityPermission) {
073        super(entityPermission);
074        
075        _value = value;
076        _pk = value.getPrimaryKey();
077    }
078    
079    @Override
080    public CommunicationSourceDetailFactory getBaseFactoryInstance() {
081        return CommunicationSourceDetailFactory.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 CommunicationSourceDetail) {
105            CommunicationSourceDetail that = (CommunicationSourceDetail)other;
106            
107            CommunicationSourceDetailValue thatValue = that.getCommunicationSourceDetailValue();
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 CommunicationSourceDetailValue getCommunicationSourceDetailValue() {
133        return _value;
134    }
135    
136    public void setCommunicationSourceDetailValue(CommunicationSourceDetailValue value)
137            throws PersistenceReadOnlyException {
138        checkReadWrite();
139        _value = value;
140    }
141    
142    @Override
143    public CommunicationSourceDetailPK getPrimaryKey() {
144        return _pk;
145    }
146    
147    public CommunicationSourcePK getCommunicationSourcePK() {
148        return _value.getCommunicationSourcePK();
149    }
150    
151    public CommunicationSource getCommunicationSource(Session session, EntityPermission entityPermission) {
152        return CommunicationSourceFactory.getInstance().getEntityFromPK(session, entityPermission, getCommunicationSourcePK());
153    }
154    
155    public CommunicationSource getCommunicationSource(EntityPermission entityPermission) {
156        return getCommunicationSource(ThreadSession.currentSession(), entityPermission);
157    }
158    
159    public CommunicationSource getCommunicationSource(Session session) {
160        return getCommunicationSource(session, EntityPermission.READ_ONLY);
161    }
162    
163    public CommunicationSource getCommunicationSource() {
164        return getCommunicationSource(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
165    }
166    
167    public CommunicationSource getCommunicationSourceForUpdate(Session session) {
168        return getCommunicationSource(session, EntityPermission.READ_WRITE);
169    }
170    
171    public CommunicationSource getCommunicationSourceForUpdate() {
172        return getCommunicationSource(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
173    }
174    
175    public void setCommunicationSourcePK(CommunicationSourcePK communicationSourcePK)
176            throws PersistenceNotNullException, PersistenceReadOnlyException {
177        checkReadWrite();
178        _value.setCommunicationSourcePK(communicationSourcePK);
179    }
180    
181    public void setCommunicationSource(CommunicationSource entity) {
182        setCommunicationSourcePK(entity == null? null: entity.getPrimaryKey());
183    }
184    
185    public boolean getCommunicationSourcePKHasBeenModified() {
186        return _value.getCommunicationSourcePKHasBeenModified();
187    }
188    
189    public String getCommunicationSourceName() {
190        return _value.getCommunicationSourceName();
191    }
192    
193    public void setCommunicationSourceName(String communicationSourceName)
194            throws PersistenceNotNullException, PersistenceReadOnlyException {
195        checkReadWrite();
196        _value.setCommunicationSourceName(communicationSourceName);
197    }
198    
199    public boolean getCommunicationSourceNameHasBeenModified() {
200        return _value.getCommunicationSourceNameHasBeenModified();
201    }
202    
203    public CommunicationSourceTypePK getCommunicationSourceTypePK() {
204        return _value.getCommunicationSourceTypePK();
205    }
206    
207    public CommunicationSourceType getCommunicationSourceType(Session session, EntityPermission entityPermission) {
208        return CommunicationSourceTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getCommunicationSourceTypePK());
209    }
210    
211    public CommunicationSourceType getCommunicationSourceType(EntityPermission entityPermission) {
212        return getCommunicationSourceType(ThreadSession.currentSession(), entityPermission);
213    }
214    
215    public CommunicationSourceType getCommunicationSourceType(Session session) {
216        return getCommunicationSourceType(session, EntityPermission.READ_ONLY);
217    }
218    
219    public CommunicationSourceType getCommunicationSourceType() {
220        return getCommunicationSourceType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
221    }
222    
223    public CommunicationSourceType getCommunicationSourceTypeForUpdate(Session session) {
224        return getCommunicationSourceType(session, EntityPermission.READ_WRITE);
225    }
226    
227    public CommunicationSourceType getCommunicationSourceTypeForUpdate() {
228        return getCommunicationSourceType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
229    }
230    
231    public void setCommunicationSourceTypePK(CommunicationSourceTypePK communicationSourceTypePK)
232            throws PersistenceNotNullException, PersistenceReadOnlyException {
233        checkReadWrite();
234        _value.setCommunicationSourceTypePK(communicationSourceTypePK);
235    }
236    
237    public void setCommunicationSourceType(CommunicationSourceType entity) {
238        setCommunicationSourceTypePK(entity == null? null: entity.getPrimaryKey());
239    }
240    
241    public boolean getCommunicationSourceTypePKHasBeenModified() {
242        return _value.getCommunicationSourceTypePKHasBeenModified();
243    }
244    
245    public Integer getSortOrder() {
246        return _value.getSortOrder();
247    }
248    
249    public void setSortOrder(Integer sortOrder)
250            throws PersistenceNotNullException, PersistenceReadOnlyException {
251        checkReadWrite();
252        _value.setSortOrder(sortOrder);
253    }
254    
255    public boolean getSortOrderHasBeenModified() {
256        return _value.getSortOrderHasBeenModified();
257    }
258    
259    public Long getFromTime() {
260        return _value.getFromTime();
261    }
262    
263    public void setFromTime(Long fromTime)
264            throws PersistenceNotNullException, PersistenceReadOnlyException {
265        checkReadWrite();
266        _value.setFromTime(fromTime);
267    }
268    
269    public boolean getFromTimeHasBeenModified() {
270        return _value.getFromTimeHasBeenModified();
271    }
272    
273    public Long getThruTime() {
274        return _value.getThruTime();
275    }
276    
277    public void setThruTime(Long thruTime)
278            throws PersistenceNotNullException, PersistenceReadOnlyException {
279        checkReadWrite();
280        _value.setThruTime(thruTime);
281    }
282    
283    public boolean getThruTimeHasBeenModified() {
284        return _value.getThruTimeHasBeenModified();
285    }
286    
287}