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 * SubscriptionDetail.java
021 */
022
023package com.echothree.model.data.subscription.server.entity;
024
025import com.echothree.model.data.subscription.common.pk.SubscriptionDetailPK;
026
027import com.echothree.model.data.subscription.common.pk.SubscriptionPK;
028import com.echothree.model.data.subscription.common.pk.SubscriptionTypePK;
029import com.echothree.model.data.party.common.pk.PartyPK;
030
031import com.echothree.model.data.subscription.server.entity.Subscription;
032import com.echothree.model.data.subscription.server.entity.SubscriptionType;
033import com.echothree.model.data.party.server.entity.Party;
034
035import com.echothree.model.data.subscription.server.factory.SubscriptionFactory;
036import com.echothree.model.data.subscription.server.factory.SubscriptionTypeFactory;
037import com.echothree.model.data.party.server.factory.PartyFactory;
038
039import com.echothree.model.data.subscription.common.pk.SubscriptionDetailPK;
040
041import com.echothree.model.data.subscription.server.value.SubscriptionDetailValue;
042
043import com.echothree.model.data.subscription.server.factory.SubscriptionDetailFactory;
044
045import com.echothree.util.common.exception.PersistenceException;
046import com.echothree.util.common.exception.PersistenceDatabaseException;
047import com.echothree.util.common.exception.PersistenceNotNullException;
048import com.echothree.util.common.exception.PersistenceReadOnlyException;
049
050import com.echothree.util.common.persistence.BasePK;
051
052import com.echothree.util.common.persistence.type.ByteArray;
053
054import com.echothree.util.server.persistence.BaseEntity;
055import com.echothree.util.server.persistence.EntityPermission;
056import com.echothree.util.server.persistence.Session;
057import com.echothree.util.server.persistence.ThreadSession;
058
059import java.io.Serializable;
060
061public class SubscriptionDetail
062        extends BaseEntity
063        implements Serializable {
064    
065    private SubscriptionDetailPK _pk;
066    private SubscriptionDetailValue _value;
067    
068    /** Creates a new instance of SubscriptionDetail */
069    public SubscriptionDetail()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of SubscriptionDetail */
075    public SubscriptionDetail(SubscriptionDetailValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public SubscriptionDetailFactory getBaseFactoryInstance() {
084        return SubscriptionDetailFactory.getInstance();
085    }
086    
087    @Override
088    public boolean hasBeenModified() {
089        return _value.hasBeenModified();
090    }
091    
092    @Override
093    public int hashCode() {
094        return _pk.hashCode();
095    }
096    
097    @Override
098    public String toString() {
099        return _pk.toString();
100    }
101    
102    @Override
103    public boolean equals(Object other) {
104        if(this == other)
105            return true;
106        
107        if(other instanceof SubscriptionDetail that) {
108            SubscriptionDetailValue thatValue = that.getSubscriptionDetailValue();
109            return _value.equals(thatValue);
110        } else {
111            return false;
112        }
113    }
114    
115    @Override
116    public void store(Session session)
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().store(session, this);
119    }
120    
121    @Override
122    public void remove(Session session)
123            throws PersistenceDatabaseException {
124        getBaseFactoryInstance().remove(session, this);
125    }
126    
127    @Override
128    public void remove()
129            throws PersistenceDatabaseException {
130        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
131    }
132    
133    public SubscriptionDetailValue getSubscriptionDetailValue() {
134        return _value;
135    }
136    
137    public void setSubscriptionDetailValue(SubscriptionDetailValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    public SubscriptionDetailPK getPrimaryKey() {
145        return _pk;
146    }
147    
148    public SubscriptionPK getSubscriptionPK() {
149        return _value.getSubscriptionPK();
150    }
151    
152    public Subscription getSubscription(Session session, EntityPermission entityPermission) {
153        return SubscriptionFactory.getInstance().getEntityFromPK(session, entityPermission, getSubscriptionPK());
154    }
155    
156    public Subscription getSubscription(EntityPermission entityPermission) {
157        return getSubscription(ThreadSession.currentSession(), entityPermission);
158    }
159    
160    public Subscription getSubscription(Session session) {
161        return getSubscription(session, EntityPermission.READ_ONLY);
162    }
163    
164    public Subscription getSubscription() {
165        return getSubscription(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
166    }
167    
168    public Subscription getSubscriptionForUpdate(Session session) {
169        return getSubscription(session, EntityPermission.READ_WRITE);
170    }
171    
172    public Subscription getSubscriptionForUpdate() {
173        return getSubscription(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
174    }
175    
176    public void setSubscriptionPK(SubscriptionPK subscriptionPK)
177            throws PersistenceNotNullException, PersistenceReadOnlyException {
178        checkReadWrite();
179        _value.setSubscriptionPK(subscriptionPK);
180    }
181    
182    public void setSubscription(Subscription entity) {
183        setSubscriptionPK(entity == null? null: entity.getPrimaryKey());
184    }
185    
186    public boolean getSubscriptionPKHasBeenModified() {
187        return _value.getSubscriptionPKHasBeenModified();
188    }
189    
190    public String getSubscriptionName() {
191        return _value.getSubscriptionName();
192    }
193    
194    public void setSubscriptionName(String subscriptionName)
195            throws PersistenceNotNullException, PersistenceReadOnlyException {
196        checkReadWrite();
197        _value.setSubscriptionName(subscriptionName);
198    }
199    
200    public boolean getSubscriptionNameHasBeenModified() {
201        return _value.getSubscriptionNameHasBeenModified();
202    }
203    
204    public SubscriptionTypePK getSubscriptionTypePK() {
205        return _value.getSubscriptionTypePK();
206    }
207    
208    public SubscriptionType getSubscriptionType(Session session, EntityPermission entityPermission) {
209        return SubscriptionTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getSubscriptionTypePK());
210    }
211    
212    public SubscriptionType getSubscriptionType(EntityPermission entityPermission) {
213        return getSubscriptionType(ThreadSession.currentSession(), entityPermission);
214    }
215    
216    public SubscriptionType getSubscriptionType(Session session) {
217        return getSubscriptionType(session, EntityPermission.READ_ONLY);
218    }
219    
220    public SubscriptionType getSubscriptionType() {
221        return getSubscriptionType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
222    }
223    
224    public SubscriptionType getSubscriptionTypeForUpdate(Session session) {
225        return getSubscriptionType(session, EntityPermission.READ_WRITE);
226    }
227    
228    public SubscriptionType getSubscriptionTypeForUpdate() {
229        return getSubscriptionType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
230    }
231    
232    public void setSubscriptionTypePK(SubscriptionTypePK subscriptionTypePK)
233            throws PersistenceNotNullException, PersistenceReadOnlyException {
234        checkReadWrite();
235        _value.setSubscriptionTypePK(subscriptionTypePK);
236    }
237    
238    public void setSubscriptionType(SubscriptionType entity) {
239        setSubscriptionTypePK(entity == null? null: entity.getPrimaryKey());
240    }
241    
242    public boolean getSubscriptionTypePKHasBeenModified() {
243        return _value.getSubscriptionTypePKHasBeenModified();
244    }
245    
246    public PartyPK getPartyPK() {
247        return _value.getPartyPK();
248    }
249    
250    public Party getParty(Session session, EntityPermission entityPermission) {
251        return PartyFactory.getInstance().getEntityFromPK(session, entityPermission, getPartyPK());
252    }
253    
254    public Party getParty(EntityPermission entityPermission) {
255        return getParty(ThreadSession.currentSession(), entityPermission);
256    }
257    
258    public Party getParty(Session session) {
259        return getParty(session, EntityPermission.READ_ONLY);
260    }
261    
262    public Party getParty() {
263        return getParty(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
264    }
265    
266    public Party getPartyForUpdate(Session session) {
267        return getParty(session, EntityPermission.READ_WRITE);
268    }
269    
270    public Party getPartyForUpdate() {
271        return getParty(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
272    }
273    
274    public void setPartyPK(PartyPK partyPK)
275            throws PersistenceNotNullException, PersistenceReadOnlyException {
276        checkReadWrite();
277        _value.setPartyPK(partyPK);
278    }
279    
280    public void setParty(Party entity) {
281        setPartyPK(entity == null? null: entity.getPrimaryKey());
282    }
283    
284    public boolean getPartyPKHasBeenModified() {
285        return _value.getPartyPKHasBeenModified();
286    }
287    
288    public Long getStartTime() {
289        return _value.getStartTime();
290    }
291    
292    public void setStartTime(Long startTime)
293            throws PersistenceNotNullException, PersistenceReadOnlyException {
294        checkReadWrite();
295        _value.setStartTime(startTime);
296    }
297    
298    public boolean getStartTimeHasBeenModified() {
299        return _value.getStartTimeHasBeenModified();
300    }
301    
302    public Long getEndTime() {
303        return _value.getEndTime();
304    }
305    
306    public void setEndTime(Long endTime)
307            throws PersistenceNotNullException, PersistenceReadOnlyException {
308        checkReadWrite();
309        _value.setEndTime(endTime);
310    }
311    
312    public boolean getEndTimeHasBeenModified() {
313        return _value.getEndTimeHasBeenModified();
314    }
315    
316    public Long getFromTime() {
317        return _value.getFromTime();
318    }
319    
320    public void setFromTime(Long fromTime)
321            throws PersistenceNotNullException, PersistenceReadOnlyException {
322        checkReadWrite();
323        _value.setFromTime(fromTime);
324    }
325    
326    public boolean getFromTimeHasBeenModified() {
327        return _value.getFromTimeHasBeenModified();
328    }
329    
330    public Long getThruTime() {
331        return _value.getThruTime();
332    }
333    
334    public void setThruTime(Long thruTime)
335            throws PersistenceNotNullException, PersistenceReadOnlyException {
336        checkReadWrite();
337        _value.setThruTime(thruTime);
338    }
339    
340    public boolean getThruTimeHasBeenModified() {
341        return _value.getThruTimeHasBeenModified();
342    }
343    
344}