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 * ContactMechanismPurpose.java
021 */
022
023package com.echothree.model.data.contact.server.entity;
024
025import com.echothree.model.data.contact.common.pk.ContactMechanismPurposePK;
026
027import com.echothree.model.data.contact.common.pk.ContactMechanismTypePK;
028
029import com.echothree.model.data.contact.server.entity.ContactMechanismType;
030
031import com.echothree.model.data.contact.server.factory.ContactMechanismTypeFactory;
032
033import com.echothree.model.data.contact.common.pk.ContactMechanismPurposePK;
034
035import com.echothree.model.data.contact.server.value.ContactMechanismPurposeValue;
036
037import com.echothree.model.data.contact.server.factory.ContactMechanismPurposeFactory;
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 ContactMechanismPurpose
056        extends BaseEntity
057        implements Serializable {
058    
059    private ContactMechanismPurposePK _pk;
060    private ContactMechanismPurposeValue _value;
061    
062    /** Creates a new instance of ContactMechanismPurpose */
063    public ContactMechanismPurpose()
064            throws PersistenceException {
065        super();
066    }
067    
068    /** Creates a new instance of ContactMechanismPurpose */
069    public ContactMechanismPurpose(ContactMechanismPurposeValue value, EntityPermission entityPermission) {
070        super(entityPermission);
071        
072        _value = value;
073        _pk = value.getPrimaryKey();
074    }
075    
076    @Override
077    public ContactMechanismPurposeFactory getBaseFactoryInstance() {
078        return ContactMechanismPurposeFactory.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 ContactMechanismPurpose that) {
102            ContactMechanismPurposeValue thatValue = that.getContactMechanismPurposeValue();
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 ContactMechanismPurposeValue getContactMechanismPurposeValue() {
128        return _value;
129    }
130    
131    public void setContactMechanismPurposeValue(ContactMechanismPurposeValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    public ContactMechanismPurposePK getPrimaryKey() {
139        return _pk;
140    }
141    
142    public String getContactMechanismPurposeName() {
143        return _value.getContactMechanismPurposeName();
144    }
145    
146    public void setContactMechanismPurposeName(String contactMechanismPurposeName)
147            throws PersistenceNotNullException, PersistenceReadOnlyException {
148        checkReadWrite();
149        _value.setContactMechanismPurposeName(contactMechanismPurposeName);
150    }
151    
152    public boolean getContactMechanismPurposeNameHasBeenModified() {
153        return _value.getContactMechanismPurposeNameHasBeenModified();
154    }
155    
156    public ContactMechanismTypePK getContactMechanismTypePK() {
157        return _value.getContactMechanismTypePK();
158    }
159    
160    public ContactMechanismType getContactMechanismType(Session session, EntityPermission entityPermission) {
161        return ContactMechanismTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getContactMechanismTypePK());
162    }
163    
164    public ContactMechanismType getContactMechanismType(EntityPermission entityPermission) {
165        return getContactMechanismType(ThreadSession.currentSession(), entityPermission);
166    }
167    
168    public ContactMechanismType getContactMechanismType(Session session) {
169        return getContactMechanismType(session, EntityPermission.READ_ONLY);
170    }
171    
172    public ContactMechanismType getContactMechanismType() {
173        return getContactMechanismType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
174    }
175    
176    public ContactMechanismType getContactMechanismTypeForUpdate(Session session) {
177        return getContactMechanismType(session, EntityPermission.READ_WRITE);
178    }
179    
180    public ContactMechanismType getContactMechanismTypeForUpdate() {
181        return getContactMechanismType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
182    }
183    
184    public void setContactMechanismTypePK(ContactMechanismTypePK contactMechanismTypePK)
185            throws PersistenceNotNullException, PersistenceReadOnlyException {
186        checkReadWrite();
187        _value.setContactMechanismTypePK(contactMechanismTypePK);
188    }
189    
190    public void setContactMechanismType(ContactMechanismType entity) {
191        setContactMechanismTypePK(entity == null? null: entity.getPrimaryKey());
192    }
193    
194    public boolean getContactMechanismTypePKHasBeenModified() {
195        return _value.getContactMechanismTypePKHasBeenModified();
196    }
197    
198    public Boolean getEventSubscriber() {
199        return _value.getEventSubscriber();
200    }
201    
202    public void setEventSubscriber(Boolean eventSubscriber)
203            throws PersistenceNotNullException, PersistenceReadOnlyException {
204        checkReadWrite();
205        _value.setEventSubscriber(eventSubscriber);
206    }
207    
208    public boolean getEventSubscriberHasBeenModified() {
209        return _value.getEventSubscriberHasBeenModified();
210    }
211    
212    public Boolean getIsDefault() {
213        return _value.getIsDefault();
214    }
215    
216    public void setIsDefault(Boolean isDefault)
217            throws PersistenceNotNullException, PersistenceReadOnlyException {
218        checkReadWrite();
219        _value.setIsDefault(isDefault);
220    }
221    
222    public boolean getIsDefaultHasBeenModified() {
223        return _value.getIsDefaultHasBeenModified();
224    }
225    
226    public Integer getSortOrder() {
227        return _value.getSortOrder();
228    }
229    
230    public void setSortOrder(Integer sortOrder)
231            throws PersistenceNotNullException, PersistenceReadOnlyException {
232        checkReadWrite();
233        _value.setSortOrder(sortOrder);
234    }
235    
236    public boolean getSortOrderHasBeenModified() {
237        return _value.getSortOrderHasBeenModified();
238    }
239    
240}