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 * ClubItem.java
021 */
022
023package com.echothree.model.data.club.server.entity;
024
025import com.echothree.model.data.club.common.pk.ClubItemPK;
026
027import com.echothree.model.data.club.common.pk.ClubPK;
028import com.echothree.model.data.club.common.pk.ClubItemTypePK;
029import com.echothree.model.data.item.common.pk.ItemPK;
030
031import com.echothree.model.data.club.server.entity.Club;
032import com.echothree.model.data.club.server.entity.ClubItemType;
033import com.echothree.model.data.item.server.entity.Item;
034
035import com.echothree.model.data.club.server.factory.ClubFactory;
036import com.echothree.model.data.club.server.factory.ClubItemTypeFactory;
037import com.echothree.model.data.item.server.factory.ItemFactory;
038
039import com.echothree.model.data.club.common.pk.ClubItemPK;
040
041import com.echothree.model.data.club.server.value.ClubItemValue;
042
043import com.echothree.model.data.club.server.factory.ClubItemFactory;
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 ClubItem
062        extends BaseEntity
063        implements Serializable {
064    
065    private ClubItemPK _pk;
066    private ClubItemValue _value;
067    
068    /** Creates a new instance of ClubItem */
069    public ClubItem()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of ClubItem */
075    public ClubItem(ClubItemValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public ClubItemFactory getBaseFactoryInstance() {
084        return ClubItemFactory.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 ClubItem that) {
108            ClubItemValue thatValue = that.getClubItemValue();
109            return _value.equals(thatValue);
110        } else {
111            return false;
112        }
113    }
114    
115    @Override
116    public void store()
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().store(this);
119    }
120    
121    @Override
122    public void remove()
123            throws PersistenceDatabaseException {
124        getBaseFactoryInstance().remove(this);
125    }
126    
127    public ClubItemValue getClubItemValue() {
128        return _value;
129    }
130    
131    public void setClubItemValue(ClubItemValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    public ClubItemPK getPrimaryKey() {
139        return _pk;
140    }
141    
142    public ClubPK getClubPK() {
143        return _value.getClubPK();
144    }
145    
146    public Club getClub(EntityPermission entityPermission) {
147        return ClubFactory.getInstance().getEntityFromPK(entityPermission, getClubPK());
148    }
149    
150    public Club getClub() {
151        return getClub(EntityPermission.READ_ONLY);
152    }
153    
154    public Club getClubForUpdate() {
155        return getClub(EntityPermission.READ_WRITE);
156    }
157    
158    public void setClubPK(ClubPK clubPK)
159            throws PersistenceNotNullException, PersistenceReadOnlyException {
160        checkReadWrite();
161        _value.setClubPK(clubPK);
162    }
163    
164    public void setClub(Club entity) {
165        setClubPK(entity == null? null: entity.getPrimaryKey());
166    }
167    
168    public boolean getClubPKHasBeenModified() {
169        return _value.getClubPKHasBeenModified();
170    }
171    
172    public ClubItemTypePK getClubItemTypePK() {
173        return _value.getClubItemTypePK();
174    }
175    
176    public ClubItemType getClubItemType(EntityPermission entityPermission) {
177        return ClubItemTypeFactory.getInstance().getEntityFromPK(entityPermission, getClubItemTypePK());
178    }
179    
180    public ClubItemType getClubItemType() {
181        return getClubItemType(EntityPermission.READ_ONLY);
182    }
183    
184    public ClubItemType getClubItemTypeForUpdate() {
185        return getClubItemType(EntityPermission.READ_WRITE);
186    }
187    
188    public void setClubItemTypePK(ClubItemTypePK clubItemTypePK)
189            throws PersistenceNotNullException, PersistenceReadOnlyException {
190        checkReadWrite();
191        _value.setClubItemTypePK(clubItemTypePK);
192    }
193    
194    public void setClubItemType(ClubItemType entity) {
195        setClubItemTypePK(entity == null? null: entity.getPrimaryKey());
196    }
197    
198    public boolean getClubItemTypePKHasBeenModified() {
199        return _value.getClubItemTypePKHasBeenModified();
200    }
201    
202    public ItemPK getItemPK() {
203        return _value.getItemPK();
204    }
205    
206    public Item getItem(EntityPermission entityPermission) {
207        return ItemFactory.getInstance().getEntityFromPK(entityPermission, getItemPK());
208    }
209    
210    public Item getItem() {
211        return getItem(EntityPermission.READ_ONLY);
212    }
213    
214    public Item getItemForUpdate() {
215        return getItem(EntityPermission.READ_WRITE);
216    }
217    
218    public void setItemPK(ItemPK itemPK)
219            throws PersistenceNotNullException, PersistenceReadOnlyException {
220        checkReadWrite();
221        _value.setItemPK(itemPK);
222    }
223    
224    public void setItem(Item entity) {
225        setItemPK(entity == null? null: entity.getPrimaryKey());
226    }
227    
228    public boolean getItemPKHasBeenModified() {
229        return _value.getItemPKHasBeenModified();
230    }
231    
232    public Long getSubscriptionTime() {
233        return _value.getSubscriptionTime();
234    }
235    
236    public void setSubscriptionTime(Long subscriptionTime)
237            throws PersistenceNotNullException, PersistenceReadOnlyException {
238        checkReadWrite();
239        _value.setSubscriptionTime(subscriptionTime);
240    }
241    
242    public boolean getSubscriptionTimeHasBeenModified() {
243        return _value.getSubscriptionTimeHasBeenModified();
244    }
245    
246    public Long getFromTime() {
247        return _value.getFromTime();
248    }
249    
250    public void setFromTime(Long fromTime)
251            throws PersistenceNotNullException, PersistenceReadOnlyException {
252        checkReadWrite();
253        _value.setFromTime(fromTime);
254    }
255    
256    public boolean getFromTimeHasBeenModified() {
257        return _value.getFromTimeHasBeenModified();
258    }
259    
260    public Long getThruTime() {
261        return _value.getThruTime();
262    }
263    
264    public void setThruTime(Long thruTime)
265            throws PersistenceNotNullException, PersistenceReadOnlyException {
266        checkReadWrite();
267        _value.setThruTime(thruTime);
268    }
269    
270    public boolean getThruTimeHasBeenModified() {
271        return _value.getThruTimeHasBeenModified();
272    }
273    
274}