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 * EntityVisit.java
021 */
022
023package com.echothree.model.data.core.server.entity;
024
025import com.echothree.model.data.core.common.pk.EntityVisitPK;
026
027import com.echothree.model.data.core.common.pk.EntityInstancePK;
028
029import com.echothree.model.data.core.server.entity.EntityInstance;
030
031import com.echothree.model.data.core.server.factory.EntityInstanceFactory;
032
033import com.echothree.model.data.core.common.pk.EntityVisitPK;
034
035import com.echothree.model.data.core.server.value.EntityVisitValue;
036
037import com.echothree.model.data.core.server.factory.EntityVisitFactory;
038
039import com.echothree.util.common.exception.PersistenceException;
040import com.echothree.util.common.exception.PersistenceDatabaseException;
041import com.echothree.util.common.exception.PersistenceNotNullException;
042import com.echothree.util.common.exception.PersistenceReadOnlyException;
043
044import com.echothree.util.common.persistence.BasePK;
045
046import com.echothree.util.common.persistence.type.ByteArray;
047
048import com.echothree.util.server.persistence.BaseEntity;
049import com.echothree.util.server.persistence.EntityPermission;
050import com.echothree.util.server.persistence.Session;
051import com.echothree.util.server.persistence.ThreadSession;
052
053import java.io.Serializable;
054
055public class EntityVisit
056        extends BaseEntity
057        implements Serializable {
058    
059    private EntityVisitPK _pk;
060    private EntityVisitValue _value;
061    
062    /** Creates a new instance of EntityVisit */
063    public EntityVisit()
064            throws PersistenceException {
065        super();
066    }
067    
068    /** Creates a new instance of EntityVisit */
069    public EntityVisit(EntityVisitValue value, EntityPermission entityPermission) {
070        super(entityPermission);
071        
072        _value = value;
073        _pk = value.getPrimaryKey();
074    }
075    
076    @Override
077    public EntityVisitFactory getBaseFactoryInstance() {
078        return EntityVisitFactory.getInstance();
079    }
080    
081    @Override
082    public boolean hasBeenModified() {
083        return _value.hasBeenModified();
084    }
085    
086    @Override
087    public int hashCode() {
088        return _pk.hashCode();
089    }
090    
091    @Override
092    public String toString() {
093        return _pk.toString();
094    }
095    
096    @Override
097    public boolean equals(Object other) {
098        if(this == other)
099            return true;
100        
101        if(other instanceof EntityVisit that) {
102            EntityVisitValue thatValue = that.getEntityVisitValue();
103            return _value.equals(thatValue);
104        } else {
105            return false;
106        }
107    }
108    
109    @Override
110    public void store(Session session)
111            throws PersistenceDatabaseException {
112        getBaseFactoryInstance().store(session, this);
113    }
114    
115    @Override
116    public void remove(Session session)
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().remove(session, this);
119    }
120    
121    @Override
122    public void remove()
123            throws PersistenceDatabaseException {
124        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
125    }
126    
127    public EntityVisitValue getEntityVisitValue() {
128        return _value;
129    }
130    
131    public void setEntityVisitValue(EntityVisitValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    public EntityVisitPK getPrimaryKey() {
139        return _pk;
140    }
141    
142    public EntityInstancePK getEntityInstancePK() {
143        return _value.getEntityInstancePK();
144    }
145    
146    public EntityInstance getEntityInstance(Session session, EntityPermission entityPermission) {
147        return EntityInstanceFactory.getInstance().getEntityFromPK(session, entityPermission, getEntityInstancePK());
148    }
149    
150    public EntityInstance getEntityInstance(EntityPermission entityPermission) {
151        return getEntityInstance(ThreadSession.currentSession(), entityPermission);
152    }
153    
154    public EntityInstance getEntityInstance(Session session) {
155        return getEntityInstance(session, EntityPermission.READ_ONLY);
156    }
157    
158    public EntityInstance getEntityInstance() {
159        return getEntityInstance(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
160    }
161    
162    public EntityInstance getEntityInstanceForUpdate(Session session) {
163        return getEntityInstance(session, EntityPermission.READ_WRITE);
164    }
165    
166    public EntityInstance getEntityInstanceForUpdate() {
167        return getEntityInstance(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
168    }
169    
170    public void setEntityInstancePK(EntityInstancePK entityInstancePK)
171            throws PersistenceNotNullException, PersistenceReadOnlyException {
172        checkReadWrite();
173        _value.setEntityInstancePK(entityInstancePK);
174    }
175    
176    public void setEntityInstance(EntityInstance entity) {
177        setEntityInstancePK(entity == null? null: entity.getPrimaryKey());
178    }
179    
180    public boolean getEntityInstancePKHasBeenModified() {
181        return _value.getEntityInstancePKHasBeenModified();
182    }
183    
184    public EntityInstancePK getVisitedEntityInstancePK() {
185        return _value.getVisitedEntityInstancePK();
186    }
187    
188    public EntityInstance getVisitedEntityInstance(Session session, EntityPermission entityPermission) {
189        return EntityInstanceFactory.getInstance().getEntityFromPK(session, entityPermission, getVisitedEntityInstancePK());
190    }
191    
192    public EntityInstance getVisitedEntityInstance(EntityPermission entityPermission) {
193        return getVisitedEntityInstance(ThreadSession.currentSession(), entityPermission);
194    }
195    
196    public EntityInstance getVisitedEntityInstance(Session session) {
197        return getVisitedEntityInstance(session, EntityPermission.READ_ONLY);
198    }
199    
200    public EntityInstance getVisitedEntityInstance() {
201        return getVisitedEntityInstance(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
202    }
203    
204    public EntityInstance getVisitedEntityInstanceForUpdate(Session session) {
205        return getVisitedEntityInstance(session, EntityPermission.READ_WRITE);
206    }
207    
208    public EntityInstance getVisitedEntityInstanceForUpdate() {
209        return getVisitedEntityInstance(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
210    }
211    
212    public void setVisitedEntityInstancePK(EntityInstancePK visitedEntityInstancePK)
213            throws PersistenceNotNullException, PersistenceReadOnlyException {
214        checkReadWrite();
215        _value.setVisitedEntityInstancePK(visitedEntityInstancePK);
216    }
217    
218    public void setVisitedEntityInstance(EntityInstance entity) {
219        setVisitedEntityInstancePK(entity == null? null: entity.getPrimaryKey());
220    }
221    
222    public boolean getVisitedEntityInstancePKHasBeenModified() {
223        return _value.getVisitedEntityInstancePKHasBeenModified();
224    }
225    
226    public Long getVisitedTime() {
227        return _value.getVisitedTime();
228    }
229    
230    public void setVisitedTime(Long visitedTime)
231            throws PersistenceNotNullException, PersistenceReadOnlyException {
232        checkReadWrite();
233        _value.setVisitedTime(visitedTime);
234    }
235    
236    public boolean getVisitedTimeHasBeenModified() {
237        return _value.getVisitedTimeHasBeenModified();
238    }
239    
240}