001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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) {
108            UserSession that = (UserSession)other;
109            
110            UserSessionValue thatValue = that.getUserSessionValue();
111            return _value.equals(thatValue);
112        } else {
113            return false;
114        }
115    }
116    
117    @Override
118    public void store(Session session)
119            throws PersistenceDatabaseException {
120        getBaseFactoryInstance().store(session, this);
121    }
122    
123    @Override
124    public void remove(Session session)
125            throws PersistenceDatabaseException {
126        getBaseFactoryInstance().remove(session, this);
127    }
128    
129    @Override
130    public void remove()
131            throws PersistenceDatabaseException {
132        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
133    }
134    
135    public UserSessionValue getUserSessionValue() {
136        return _value;
137    }
138    
139    public void setUserSessionValue(UserSessionValue value)
140            throws PersistenceReadOnlyException {
141        checkReadWrite();
142        _value = value;
143    }
144    
145    @Override
146    public UserSessionPK getPrimaryKey() {
147        return _pk;
148    }
149    
150    public UserVisitPK getUserVisitPK() {
151        return _value.getUserVisitPK();
152    }
153    
154    public UserVisit getUserVisit(Session session, EntityPermission entityPermission) {
155        return UserVisitFactory.getInstance().getEntityFromPK(session, entityPermission, getUserVisitPK());
156    }
157    
158    public UserVisit getUserVisit(EntityPermission entityPermission) {
159        return getUserVisit(ThreadSession.currentSession(), entityPermission);
160    }
161    
162    public UserVisit getUserVisit(Session session) {
163        return getUserVisit(session, EntityPermission.READ_ONLY);
164    }
165    
166    public UserVisit getUserVisit() {
167        return getUserVisit(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
168    }
169    
170    public UserVisit getUserVisitForUpdate(Session session) {
171        return getUserVisit(session, EntityPermission.READ_WRITE);
172    }
173    
174    public UserVisit getUserVisitForUpdate() {
175        return getUserVisit(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
176    }
177    
178    public void setUserVisitPK(UserVisitPK userVisitPK)
179            throws PersistenceNotNullException, PersistenceReadOnlyException {
180        checkReadWrite();
181        _value.setUserVisitPK(userVisitPK);
182    }
183    
184    public void setUserVisit(UserVisit entity) {
185        setUserVisitPK(entity == null? null: entity.getPrimaryKey());
186    }
187    
188    public boolean getUserVisitPKHasBeenModified() {
189        return _value.getUserVisitPKHasBeenModified();
190    }
191    
192    public PartyPK getPartyPK() {
193        return _value.getPartyPK();
194    }
195    
196    public Party getParty(Session session, EntityPermission entityPermission) {
197        return PartyFactory.getInstance().getEntityFromPK(session, entityPermission, getPartyPK());
198    }
199    
200    public Party getParty(EntityPermission entityPermission) {
201        return getParty(ThreadSession.currentSession(), entityPermission);
202    }
203    
204    public Party getParty(Session session) {
205        return getParty(session, EntityPermission.READ_ONLY);
206    }
207    
208    public Party getParty() {
209        return getParty(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
210    }
211    
212    public Party getPartyForUpdate(Session session) {
213        return getParty(session, EntityPermission.READ_WRITE);
214    }
215    
216    public Party getPartyForUpdate() {
217        return getParty(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
218    }
219    
220    public void setPartyPK(PartyPK partyPK)
221            throws PersistenceNotNullException, PersistenceReadOnlyException {
222        checkReadWrite();
223        _value.setPartyPK(partyPK);
224    }
225    
226    public void setParty(Party entity) {
227        setPartyPK(entity == null? null: entity.getPrimaryKey());
228    }
229    
230    public boolean getPartyPKHasBeenModified() {
231        return _value.getPartyPKHasBeenModified();
232    }
233    
234    public PartyRelationshipPK getPartyRelationshipPK() {
235        return _value.getPartyRelationshipPK();
236    }
237    
238    public PartyRelationship getPartyRelationship(Session session, EntityPermission entityPermission) {
239        PartyRelationshipPK pk = getPartyRelationshipPK();
240        PartyRelationship entity = pk == null? null: PartyRelationshipFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
241        
242        return entity;
243    }
244    
245    public PartyRelationship getPartyRelationship(EntityPermission entityPermission) {
246        return getPartyRelationship(ThreadSession.currentSession(), entityPermission);
247    }
248    
249    public PartyRelationship getPartyRelationship(Session session) {
250        return getPartyRelationship(session, EntityPermission.READ_ONLY);
251    }
252    
253    public PartyRelationship getPartyRelationship() {
254        return getPartyRelationship(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
255    }
256    
257    public PartyRelationship getPartyRelationshipForUpdate(Session session) {
258        return getPartyRelationship(session, EntityPermission.READ_WRITE);
259    }
260    
261    public PartyRelationship getPartyRelationshipForUpdate() {
262        return getPartyRelationship(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
263    }
264    
265    public void setPartyRelationshipPK(PartyRelationshipPK partyRelationshipPK)
266            throws PersistenceNotNullException, PersistenceReadOnlyException {
267        checkReadWrite();
268        _value.setPartyRelationshipPK(partyRelationshipPK);
269    }
270    
271    public void setPartyRelationship(PartyRelationship entity) {
272        setPartyRelationshipPK(entity == null? null: entity.getPrimaryKey());
273    }
274    
275    public boolean getPartyRelationshipPKHasBeenModified() {
276        return _value.getPartyRelationshipPKHasBeenModified();
277    }
278    
279    public Long getIdentityVerifiedTime() {
280        return _value.getIdentityVerifiedTime();
281    }
282    
283    public void setIdentityVerifiedTime(Long identityVerifiedTime)
284            throws PersistenceNotNullException, PersistenceReadOnlyException {
285        checkReadWrite();
286        _value.setIdentityVerifiedTime(identityVerifiedTime);
287    }
288    
289    public boolean getIdentityVerifiedTimeHasBeenModified() {
290        return _value.getIdentityVerifiedTimeHasBeenModified();
291    }
292    
293    public Long getFromTime() {
294        return _value.getFromTime();
295    }
296    
297    public void setFromTime(Long fromTime)
298            throws PersistenceNotNullException, PersistenceReadOnlyException {
299        checkReadWrite();
300        _value.setFromTime(fromTime);
301    }
302    
303    public boolean getFromTimeHasBeenModified() {
304        return _value.getFromTimeHasBeenModified();
305    }
306    
307    public Long getThruTime() {
308        return _value.getThruTime();
309    }
310    
311    public void setThruTime(Long thruTime)
312            throws PersistenceNotNullException, PersistenceReadOnlyException {
313        checkReadWrite();
314        _value.setThruTime(thruTime);
315    }
316    
317    public boolean getThruTimeHasBeenModified() {
318        return _value.getThruTimeHasBeenModified();
319    }
320    
321}