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 * ClubDetail.java
021 */
022
023package com.echothree.model.data.club.server.entity;
024
025import com.echothree.model.data.club.common.pk.ClubDetailPK;
026
027import com.echothree.model.data.club.common.pk.ClubPK;
028import com.echothree.model.data.subscription.common.pk.SubscriptionTypePK;
029import com.echothree.model.data.filter.common.pk.FilterPK;
030import com.echothree.model.data.accounting.common.pk.CurrencyPK;
031
032import com.echothree.model.data.club.server.entity.Club;
033import com.echothree.model.data.subscription.server.entity.SubscriptionType;
034import com.echothree.model.data.filter.server.entity.Filter;
035import com.echothree.model.data.accounting.server.entity.Currency;
036
037import com.echothree.model.data.club.server.factory.ClubFactory;
038import com.echothree.model.data.subscription.server.factory.SubscriptionTypeFactory;
039import com.echothree.model.data.filter.server.factory.FilterFactory;
040import com.echothree.model.data.accounting.server.factory.CurrencyFactory;
041
042import com.echothree.model.data.club.common.pk.ClubDetailPK;
043
044import com.echothree.model.data.club.server.value.ClubDetailValue;
045
046import com.echothree.model.data.club.server.factory.ClubDetailFactory;
047
048import com.echothree.util.common.exception.PersistenceException;
049import com.echothree.util.common.exception.PersistenceDatabaseException;
050import com.echothree.util.common.exception.PersistenceNotNullException;
051import com.echothree.util.common.exception.PersistenceReadOnlyException;
052
053import com.echothree.util.common.persistence.BasePK;
054
055import com.echothree.util.common.persistence.type.ByteArray;
056
057import com.echothree.util.server.persistence.BaseEntity;
058import com.echothree.util.server.persistence.EntityPermission;
059import com.echothree.util.server.persistence.Session;
060import com.echothree.util.server.persistence.ThreadSession;
061
062import java.io.Serializable;
063
064import javax.annotation.Nonnull;
065import javax.annotation.Nullable;
066
067public class ClubDetail
068        extends BaseEntity
069        implements Serializable {
070    
071    private ClubDetailPK _pk;
072    private ClubDetailValue _value;
073    
074    /** Creates a new instance of ClubDetail */
075    public ClubDetail()
076            throws PersistenceException {
077        super();
078    }
079    
080    /** Creates a new instance of ClubDetail */
081    public ClubDetail(ClubDetailValue value, EntityPermission entityPermission) {
082        super(entityPermission);
083        
084        _value = value;
085        _pk = value.getPrimaryKey();
086    }
087    
088    @Override
089    @Nonnull
090    public ClubDetailFactory getBaseFactoryInstance() {
091        return ClubDetailFactory.getInstance();
092    }
093    
094    @Override
095    public boolean hasBeenModified() {
096        return _value.hasBeenModified();
097    }
098    
099    @Override
100    public int hashCode() {
101        return _pk.hashCode();
102    }
103    
104    @Override
105    @Nonnull
106    public String toString() {
107        return _pk.toString();
108    }
109    
110    @Override
111    public boolean equals(Object other) {
112        if(this == other)
113            return true;
114        
115        if(other instanceof ClubDetail that) {
116            ClubDetailValue thatValue = that.getClubDetailValue();
117            return _value.equals(thatValue);
118        } else {
119            return false;
120        }
121    }
122    
123    @Override
124    public void store()
125            throws PersistenceDatabaseException {
126        getBaseFactoryInstance().store(this);
127    }
128    
129    @Override
130    public void remove()
131            throws PersistenceDatabaseException {
132        getBaseFactoryInstance().remove(this);
133    }
134    
135    @Nonnull
136    public ClubDetailValue getClubDetailValue() {
137        return _value;
138    }
139    
140    public void setClubDetailValue(@Nonnull ClubDetailValue value)
141            throws PersistenceReadOnlyException {
142        checkReadWrite();
143        _value = value;
144    }
145    
146    @Override
147    @Nonnull
148    public ClubDetailPK getPrimaryKey() {
149        return _pk;
150    }
151    
152    @Nonnull
153    public ClubPK getClubPK() {
154        return _value.getClubPK();
155    }
156    
157    @Nonnull
158    public Club getClub(EntityPermission entityPermission) {
159        return ClubFactory.getInstance().getEntityFromPK(entityPermission, getClubPK());
160    }
161    
162    @Nonnull
163    public Club getClub() {
164        return getClub(EntityPermission.READ_ONLY);
165    }
166    
167    @Nonnull
168    public Club getClubForUpdate() {
169        return getClub(EntityPermission.READ_WRITE);
170    }
171    
172    public void setClubPK(@Nonnull ClubPK clubPK)
173            throws PersistenceNotNullException, PersistenceReadOnlyException {
174        checkReadWrite();
175        _value.setClubPK(clubPK);
176    }
177    
178    public void setClub(@Nonnull Club entity) {
179        setClubPK(entity == null ? null : entity.getPrimaryKey());
180    }
181    
182    public boolean getClubPKHasBeenModified() {
183        return _value.getClubPKHasBeenModified();
184    }
185    
186    @Nonnull
187    public String getClubName() {
188        return _value.getClubName();
189    }
190    
191    public void setClubName(@Nonnull String clubName)
192            throws PersistenceNotNullException, PersistenceReadOnlyException {
193        checkReadWrite();
194        _value.setClubName(clubName);
195    }
196    
197    public boolean getClubNameHasBeenModified() {
198        return _value.getClubNameHasBeenModified();
199    }
200    
201    @Nonnull
202    public SubscriptionTypePK getSubscriptionTypePK() {
203        return _value.getSubscriptionTypePK();
204    }
205    
206    @Nonnull
207    public SubscriptionType getSubscriptionType(EntityPermission entityPermission) {
208        return SubscriptionTypeFactory.getInstance().getEntityFromPK(entityPermission, getSubscriptionTypePK());
209    }
210    
211    @Nonnull
212    public SubscriptionType getSubscriptionType() {
213        return getSubscriptionType(EntityPermission.READ_ONLY);
214    }
215    
216    @Nonnull
217    public SubscriptionType getSubscriptionTypeForUpdate() {
218        return getSubscriptionType(EntityPermission.READ_WRITE);
219    }
220    
221    public void setSubscriptionTypePK(@Nonnull SubscriptionTypePK subscriptionTypePK)
222            throws PersistenceNotNullException, PersistenceReadOnlyException {
223        checkReadWrite();
224        _value.setSubscriptionTypePK(subscriptionTypePK);
225    }
226    
227    public void setSubscriptionType(@Nonnull SubscriptionType entity) {
228        setSubscriptionTypePK(entity == null ? null : entity.getPrimaryKey());
229    }
230    
231    public boolean getSubscriptionTypePKHasBeenModified() {
232        return _value.getSubscriptionTypePKHasBeenModified();
233    }
234    
235    @Nullable
236    public FilterPK getClubPriceFilterPK() {
237        return _value.getClubPriceFilterPK();
238    }
239    
240    @Nullable
241    public Filter getClubPriceFilter(EntityPermission entityPermission) {
242        FilterPK pk = getClubPriceFilterPK();
243        Filter entity = pk == null? null: FilterFactory.getInstance().getEntityFromPK(entityPermission, pk);
244        
245        return entity;
246    }
247    
248    @Nullable
249    public Filter getClubPriceFilter() {
250        return getClubPriceFilter(EntityPermission.READ_ONLY);
251    }
252    
253    @Nullable
254    public Filter getClubPriceFilterForUpdate() {
255        return getClubPriceFilter(EntityPermission.READ_WRITE);
256    }
257    
258    public void setClubPriceFilterPK(@Nullable FilterPK clubPriceFilterPK)
259            throws PersistenceNotNullException, PersistenceReadOnlyException {
260        checkReadWrite();
261        _value.setClubPriceFilterPK(clubPriceFilterPK);
262    }
263    
264    public void setClubPriceFilter(@Nullable Filter entity) {
265        setClubPriceFilterPK(entity == null ? null : entity.getPrimaryKey());
266    }
267    
268    public boolean getClubPriceFilterPKHasBeenModified() {
269        return _value.getClubPriceFilterPKHasBeenModified();
270    }
271    
272    @Nullable
273    public CurrencyPK getCurrencyPK() {
274        return _value.getCurrencyPK();
275    }
276    
277    @Nullable
278    public Currency getCurrency(EntityPermission entityPermission) {
279        CurrencyPK pk = getCurrencyPK();
280        Currency entity = pk == null? null: CurrencyFactory.getInstance().getEntityFromPK(entityPermission, pk);
281        
282        return entity;
283    }
284    
285    @Nullable
286    public Currency getCurrency() {
287        return getCurrency(EntityPermission.READ_ONLY);
288    }
289    
290    @Nullable
291    public Currency getCurrencyForUpdate() {
292        return getCurrency(EntityPermission.READ_WRITE);
293    }
294    
295    public void setCurrencyPK(@Nullable CurrencyPK currencyPK)
296            throws PersistenceNotNullException, PersistenceReadOnlyException {
297        checkReadWrite();
298        _value.setCurrencyPK(currencyPK);
299    }
300    
301    public void setCurrency(@Nullable Currency entity) {
302        setCurrencyPK(entity == null ? null : entity.getPrimaryKey());
303    }
304    
305    public boolean getCurrencyPKHasBeenModified() {
306        return _value.getCurrencyPKHasBeenModified();
307    }
308    
309    @Nonnull
310    public Boolean getIsDefault() {
311        return _value.getIsDefault();
312    }
313    
314    public void setIsDefault(@Nonnull Boolean isDefault)
315            throws PersistenceNotNullException, PersistenceReadOnlyException {
316        checkReadWrite();
317        _value.setIsDefault(isDefault);
318    }
319    
320    public boolean getIsDefaultHasBeenModified() {
321        return _value.getIsDefaultHasBeenModified();
322    }
323    
324    @Nonnull
325    public Integer getSortOrder() {
326        return _value.getSortOrder();
327    }
328    
329    public void setSortOrder(@Nonnull Integer sortOrder)
330            throws PersistenceNotNullException, PersistenceReadOnlyException {
331        checkReadWrite();
332        _value.setSortOrder(sortOrder);
333    }
334    
335    public boolean getSortOrderHasBeenModified() {
336        return _value.getSortOrderHasBeenModified();
337    }
338    
339    @Nonnull
340    public Long getFromTime() {
341        return _value.getFromTime();
342    }
343    
344    public void setFromTime(@Nonnull Long fromTime)
345            throws PersistenceNotNullException, PersistenceReadOnlyException {
346        checkReadWrite();
347        _value.setFromTime(fromTime);
348    }
349    
350    public boolean getFromTimeHasBeenModified() {
351        return _value.getFromTimeHasBeenModified();
352    }
353    
354    @Nonnull
355    public Long getThruTime() {
356        return _value.getThruTime();
357    }
358    
359    public void setThruTime(@Nonnull Long thruTime)
360            throws PersistenceNotNullException, PersistenceReadOnlyException {
361        checkReadWrite();
362        _value.setThruTime(thruTime);
363    }
364    
365    public boolean getThruTimeHasBeenModified() {
366        return _value.getThruTimeHasBeenModified();
367    }
368    
369}