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 * UserSession.java
021 */
022
023package com.echothree.model.data.user.server.entity;
024
025import com.echothree.model.data.user.common.pk.UserSessionPK;
026
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.model.data.party.common.pk.PartyPK;
029import com.echothree.model.data.party.common.pk.PartyRelationshipPK;
030
031import com.echothree.model.data.user.server.entity.UserVisit;
032import com.echothree.model.data.party.server.entity.Party;
033import com.echothree.model.data.party.server.entity.PartyRelationship;
034
035import com.echothree.model.data.user.server.factory.UserVisitFactory;
036import com.echothree.model.data.party.server.factory.PartyFactory;
037import com.echothree.model.data.party.server.factory.PartyRelationshipFactory;
038
039import com.echothree.model.data.user.common.pk.UserSessionPK;
040
041import com.echothree.model.data.user.server.value.UserSessionValue;
042
043import com.echothree.model.data.user.server.factory.UserSessionFactory;
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 UserSession
062        extends BaseEntity
063        implements Serializable {
064    
065    private UserSessionPK _pk;
066    private UserSessionValue _value;
067    
068    /** Creates a new instance of UserSession */
069    public UserSession()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of UserSession */
075    public UserSession(UserSessionValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public UserSessionFactory getBaseFactoryInstance() {
084        return UserSessionFactory.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 UserSession that) {
108            UserSessionValue thatValue = that.getUserSessionValue();
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 UserSessionValue getUserSessionValue() {
128        return _value;
129    }
130    
131    public void setUserSessionValue(UserSessionValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    public UserSessionPK getPrimaryKey() {
139        return _pk;
140    }
141    
142    public UserVisitPK getUserVisitPK() {
143        return _value.getUserVisitPK();
144    }
145    
146    public UserVisit getUserVisit(EntityPermission entityPermission) {
147        return UserVisitFactory.getInstance().getEntityFromPK(entityPermission, getUserVisitPK());
148    }
149    
150    public UserVisit getUserVisit() {
151        return getUserVisit(EntityPermission.READ_ONLY);
152    }
153    
154    public UserVisit getUserVisitForUpdate() {
155        return getUserVisit(EntityPermission.READ_WRITE);
156    }
157    
158    public void setUserVisitPK(UserVisitPK userVisitPK)
159            throws PersistenceNotNullException, PersistenceReadOnlyException {
160        checkReadWrite();
161        _value.setUserVisitPK(userVisitPK);
162    }
163    
164    public void setUserVisit(UserVisit entity) {
165        setUserVisitPK(entity == null? null: entity.getPrimaryKey());
166    }
167    
168    public boolean getUserVisitPKHasBeenModified() {
169        return _value.getUserVisitPKHasBeenModified();
170    }
171    
172    public PartyPK getPartyPK() {
173        return _value.getPartyPK();
174    }
175    
176    public Party getParty(EntityPermission entityPermission) {
177        return PartyFactory.getInstance().getEntityFromPK(entityPermission, getPartyPK());
178    }
179    
180    public Party getParty() {
181        return getParty(EntityPermission.READ_ONLY);
182    }
183    
184    public Party getPartyForUpdate() {
185        return getParty(EntityPermission.READ_WRITE);
186    }
187    
188    public void setPartyPK(PartyPK partyPK)
189            throws PersistenceNotNullException, PersistenceReadOnlyException {
190        checkReadWrite();
191        _value.setPartyPK(partyPK);
192    }
193    
194    public void setParty(Party entity) {
195        setPartyPK(entity == null? null: entity.getPrimaryKey());
196    }
197    
198    public boolean getPartyPKHasBeenModified() {
199        return _value.getPartyPKHasBeenModified();
200    }
201    
202    public PartyRelationshipPK getPartyRelationshipPK() {
203        return _value.getPartyRelationshipPK();
204    }
205    
206    public PartyRelationship getPartyRelationship(EntityPermission entityPermission) {
207        PartyRelationshipPK pk = getPartyRelationshipPK();
208        PartyRelationship entity = pk == null? null: PartyRelationshipFactory.getInstance().getEntityFromPK(entityPermission, pk);
209        
210        return entity;
211    }
212    
213    public PartyRelationship getPartyRelationship() {
214        return getPartyRelationship(EntityPermission.READ_ONLY);
215    }
216    
217    public PartyRelationship getPartyRelationshipForUpdate() {
218        return getPartyRelationship(EntityPermission.READ_WRITE);
219    }
220    
221    public void setPartyRelationshipPK(PartyRelationshipPK partyRelationshipPK)
222            throws PersistenceNotNullException, PersistenceReadOnlyException {
223        checkReadWrite();
224        _value.setPartyRelationshipPK(partyRelationshipPK);
225    }
226    
227    public void setPartyRelationship(PartyRelationship entity) {
228        setPartyRelationshipPK(entity == null? null: entity.getPrimaryKey());
229    }
230    
231    public boolean getPartyRelationshipPKHasBeenModified() {
232        return _value.getPartyRelationshipPKHasBeenModified();
233    }
234    
235    public Long getIdentityVerifiedTime() {
236        return _value.getIdentityVerifiedTime();
237    }
238    
239    public void setIdentityVerifiedTime(Long identityVerifiedTime)
240            throws PersistenceNotNullException, PersistenceReadOnlyException {
241        checkReadWrite();
242        _value.setIdentityVerifiedTime(identityVerifiedTime);
243    }
244    
245    public boolean getIdentityVerifiedTimeHasBeenModified() {
246        return _value.getIdentityVerifiedTimeHasBeenModified();
247    }
248    
249    public Long getFromTime() {
250        return _value.getFromTime();
251    }
252    
253    public void setFromTime(Long fromTime)
254            throws PersistenceNotNullException, PersistenceReadOnlyException {
255        checkReadWrite();
256        _value.setFromTime(fromTime);
257    }
258    
259    public boolean getFromTimeHasBeenModified() {
260        return _value.getFromTimeHasBeenModified();
261    }
262    
263    public Long getThruTime() {
264        return _value.getThruTime();
265    }
266    
267    public void setThruTime(Long thruTime)
268            throws PersistenceNotNullException, PersistenceReadOnlyException {
269        checkReadWrite();
270        _value.setThruTime(thruTime);
271    }
272    
273    public boolean getThruTimeHasBeenModified() {
274        return _value.getThruTimeHasBeenModified();
275    }
276    
277}