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 * ContactMechanismDetail.java
021 */
022
023package com.echothree.model.data.contact.server.entity;
024
025import com.echothree.model.data.contact.common.pk.ContactMechanismDetailPK;
026
027import com.echothree.model.data.contact.common.pk.ContactMechanismPK;
028import com.echothree.model.data.contact.common.pk.ContactMechanismTypePK;
029
030import com.echothree.model.data.contact.server.entity.ContactMechanism;
031import com.echothree.model.data.contact.server.entity.ContactMechanismType;
032
033import com.echothree.model.data.contact.server.factory.ContactMechanismFactory;
034import com.echothree.model.data.contact.server.factory.ContactMechanismTypeFactory;
035
036import com.echothree.model.data.contact.common.pk.ContactMechanismDetailPK;
037
038import com.echothree.model.data.contact.server.value.ContactMechanismDetailValue;
039
040import com.echothree.model.data.contact.server.factory.ContactMechanismDetailFactory;
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 ContactMechanismDetail
059        extends BaseEntity
060        implements Serializable {
061    
062    private ContactMechanismDetailPK _pk;
063    private ContactMechanismDetailValue _value;
064    
065    /** Creates a new instance of ContactMechanismDetail */
066    public ContactMechanismDetail()
067            throws PersistenceException {
068        super();
069    }
070    
071    /** Creates a new instance of ContactMechanismDetail */
072    public ContactMechanismDetail(ContactMechanismDetailValue value, EntityPermission entityPermission) {
073        super(entityPermission);
074        
075        _value = value;
076        _pk = value.getPrimaryKey();
077    }
078    
079    @Override
080    public ContactMechanismDetailFactory getBaseFactoryInstance() {
081        return ContactMechanismDetailFactory.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 ContactMechanismDetail that) {
105            ContactMechanismDetailValue thatValue = that.getContactMechanismDetailValue();
106            return _value.equals(thatValue);
107        } else {
108            return false;
109        }
110    }
111    
112    @Override
113    public void store(Session session)
114            throws PersistenceDatabaseException {
115        getBaseFactoryInstance().store(session, this);
116    }
117    
118    @Override
119    public void remove(Session session)
120            throws PersistenceDatabaseException {
121        getBaseFactoryInstance().remove(session, this);
122    }
123    
124    @Override
125    public void remove()
126            throws PersistenceDatabaseException {
127        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
128    }
129    
130    public ContactMechanismDetailValue getContactMechanismDetailValue() {
131        return _value;
132    }
133    
134    public void setContactMechanismDetailValue(ContactMechanismDetailValue value)
135            throws PersistenceReadOnlyException {
136        checkReadWrite();
137        _value = value;
138    }
139    
140    @Override
141    public ContactMechanismDetailPK getPrimaryKey() {
142        return _pk;
143    }
144    
145    public ContactMechanismPK getContactMechanismPK() {
146        return _value.getContactMechanismPK();
147    }
148    
149    public ContactMechanism getContactMechanism(Session session, EntityPermission entityPermission) {
150        return ContactMechanismFactory.getInstance().getEntityFromPK(session, entityPermission, getContactMechanismPK());
151    }
152    
153    public ContactMechanism getContactMechanism(EntityPermission entityPermission) {
154        return getContactMechanism(ThreadSession.currentSession(), entityPermission);
155    }
156    
157    public ContactMechanism getContactMechanism(Session session) {
158        return getContactMechanism(session, EntityPermission.READ_ONLY);
159    }
160    
161    public ContactMechanism getContactMechanism() {
162        return getContactMechanism(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
163    }
164    
165    public ContactMechanism getContactMechanismForUpdate(Session session) {
166        return getContactMechanism(session, EntityPermission.READ_WRITE);
167    }
168    
169    public ContactMechanism getContactMechanismForUpdate() {
170        return getContactMechanism(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
171    }
172    
173    public void setContactMechanismPK(ContactMechanismPK contactMechanismPK)
174            throws PersistenceNotNullException, PersistenceReadOnlyException {
175        checkReadWrite();
176        _value.setContactMechanismPK(contactMechanismPK);
177    }
178    
179    public void setContactMechanism(ContactMechanism entity) {
180        setContactMechanismPK(entity == null? null: entity.getPrimaryKey());
181    }
182    
183    public boolean getContactMechanismPKHasBeenModified() {
184        return _value.getContactMechanismPKHasBeenModified();
185    }
186    
187    public String getContactMechanismName() {
188        return _value.getContactMechanismName();
189    }
190    
191    public void setContactMechanismName(String contactMechanismName)
192            throws PersistenceNotNullException, PersistenceReadOnlyException {
193        checkReadWrite();
194        _value.setContactMechanismName(contactMechanismName);
195    }
196    
197    public boolean getContactMechanismNameHasBeenModified() {
198        return _value.getContactMechanismNameHasBeenModified();
199    }
200    
201    public ContactMechanismTypePK getContactMechanismTypePK() {
202        return _value.getContactMechanismTypePK();
203    }
204    
205    public ContactMechanismType getContactMechanismType(Session session, EntityPermission entityPermission) {
206        return ContactMechanismTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getContactMechanismTypePK());
207    }
208    
209    public ContactMechanismType getContactMechanismType(EntityPermission entityPermission) {
210        return getContactMechanismType(ThreadSession.currentSession(), entityPermission);
211    }
212    
213    public ContactMechanismType getContactMechanismType(Session session) {
214        return getContactMechanismType(session, EntityPermission.READ_ONLY);
215    }
216    
217    public ContactMechanismType getContactMechanismType() {
218        return getContactMechanismType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
219    }
220    
221    public ContactMechanismType getContactMechanismTypeForUpdate(Session session) {
222        return getContactMechanismType(session, EntityPermission.READ_WRITE);
223    }
224    
225    public ContactMechanismType getContactMechanismTypeForUpdate() {
226        return getContactMechanismType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
227    }
228    
229    public void setContactMechanismTypePK(ContactMechanismTypePK contactMechanismTypePK)
230            throws PersistenceNotNullException, PersistenceReadOnlyException {
231        checkReadWrite();
232        _value.setContactMechanismTypePK(contactMechanismTypePK);
233    }
234    
235    public void setContactMechanismType(ContactMechanismType entity) {
236        setContactMechanismTypePK(entity == null? null: entity.getPrimaryKey());
237    }
238    
239    public boolean getContactMechanismTypePKHasBeenModified() {
240        return _value.getContactMechanismTypePKHasBeenModified();
241    }
242    
243    public Boolean getAllowSolicitation() {
244        return _value.getAllowSolicitation();
245    }
246    
247    public void setAllowSolicitation(Boolean allowSolicitation)
248            throws PersistenceNotNullException, PersistenceReadOnlyException {
249        checkReadWrite();
250        _value.setAllowSolicitation(allowSolicitation);
251    }
252    
253    public boolean getAllowSolicitationHasBeenModified() {
254        return _value.getAllowSolicitationHasBeenModified();
255    }
256    
257    public Long getFromTime() {
258        return _value.getFromTime();
259    }
260    
261    public void setFromTime(Long fromTime)
262            throws PersistenceNotNullException, PersistenceReadOnlyException {
263        checkReadWrite();
264        _value.setFromTime(fromTime);
265    }
266    
267    public boolean getFromTimeHasBeenModified() {
268        return _value.getFromTimeHasBeenModified();
269    }
270    
271    public Long getThruTime() {
272        return _value.getThruTime();
273    }
274    
275    public void setThruTime(Long thruTime)
276            throws PersistenceNotNullException, PersistenceReadOnlyException {
277        checkReadWrite();
278        _value.setThruTime(thruTime);
279    }
280    
281    public boolean getThruTimeHasBeenModified() {
282        return _value.getThruTimeHasBeenModified();
283    }
284    
285}