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 * UserVisitGroup.java
021 */
022
023package com.echothree.model.data.user.server.entity;
024
025import com.echothree.model.data.user.common.pk.UserVisitGroupPK;
026
027import com.echothree.model.data.user.common.pk.UserVisitGroupDetailPK;
028
029import com.echothree.model.data.user.server.entity.UserVisitGroupDetail;
030
031import com.echothree.model.data.user.server.factory.UserVisitGroupDetailFactory;
032
033import com.echothree.model.data.user.common.pk.UserVisitGroupPK;
034
035import com.echothree.model.data.user.server.value.UserVisitGroupValue;
036
037import com.echothree.model.data.user.server.factory.UserVisitGroupFactory;
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 UserVisitGroup
056        extends BaseEntity
057        implements Serializable {
058    
059    private UserVisitGroupPK _pk;
060    private UserVisitGroupValue _value;
061    
062    /** Creates a new instance of UserVisitGroup */
063    public UserVisitGroup()
064            throws PersistenceException {
065        super();
066    }
067    
068    /** Creates a new instance of UserVisitGroup */
069    public UserVisitGroup(UserVisitGroupValue value, EntityPermission entityPermission) {
070        super(entityPermission);
071        
072        _value = value;
073        _pk = value.getPrimaryKey();
074    }
075    
076    @Override
077    public UserVisitGroupFactory getBaseFactoryInstance() {
078        return UserVisitGroupFactory.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 UserVisitGroup) {
102            UserVisitGroup that = (UserVisitGroup)other;
103            
104            UserVisitGroupValue thatValue = that.getUserVisitGroupValue();
105            return _value.equals(thatValue);
106        } else {
107            return false;
108        }
109    }
110    
111    @Override
112    public void store(Session session)
113            throws PersistenceDatabaseException {
114        getBaseFactoryInstance().store(session, this);
115    }
116    
117    @Override
118    public void remove(Session session)
119            throws PersistenceDatabaseException {
120        getBaseFactoryInstance().remove(session, this);
121    }
122    
123    @Override
124    public void remove()
125            throws PersistenceDatabaseException {
126        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
127    }
128    
129    public UserVisitGroupValue getUserVisitGroupValue() {
130        return _value;
131    }
132    
133    public void setUserVisitGroupValue(UserVisitGroupValue value)
134            throws PersistenceReadOnlyException {
135        checkReadWrite();
136        _value = value;
137    }
138    
139    @Override
140    public UserVisitGroupPK getPrimaryKey() {
141        return _pk;
142    }
143    
144    public UserVisitGroupDetailPK getActiveDetailPK() {
145        return _value.getActiveDetailPK();
146    }
147    
148    public UserVisitGroupDetail getActiveDetail(Session session, EntityPermission entityPermission) {
149        UserVisitGroupDetailPK pk = getActiveDetailPK();
150        UserVisitGroupDetail entity = pk == null? null: UserVisitGroupDetailFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
151        
152        return entity;
153    }
154    
155    public UserVisitGroupDetail getActiveDetail(EntityPermission entityPermission) {
156        return getActiveDetail(ThreadSession.currentSession(), entityPermission);
157    }
158    
159    public UserVisitGroupDetail getActiveDetail(Session session) {
160        return getActiveDetail(session, EntityPermission.READ_ONLY);
161    }
162    
163    public UserVisitGroupDetail getActiveDetail() {
164        return getActiveDetail(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
165    }
166    
167    public UserVisitGroupDetail getActiveDetailForUpdate(Session session) {
168        return getActiveDetail(session, EntityPermission.READ_WRITE);
169    }
170    
171    public UserVisitGroupDetail getActiveDetailForUpdate() {
172        return getActiveDetail(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
173    }
174    
175    public void setActiveDetailPK(UserVisitGroupDetailPK activeDetailPK)
176            throws PersistenceNotNullException, PersistenceReadOnlyException {
177        checkReadWrite();
178        _value.setActiveDetailPK(activeDetailPK);
179    }
180    
181    public void setActiveDetail(UserVisitGroupDetail entity) {
182        setActiveDetailPK(entity == null? null: entity.getPrimaryKey());
183    }
184    
185    public boolean getActiveDetailPKHasBeenModified() {
186        return _value.getActiveDetailPKHasBeenModified();
187    }
188    
189    public UserVisitGroupDetailPK getLastDetailPK() {
190        return _value.getLastDetailPK();
191    }
192    
193    public UserVisitGroupDetail getLastDetail(Session session, EntityPermission entityPermission) {
194        UserVisitGroupDetailPK pk = getLastDetailPK();
195        UserVisitGroupDetail entity = pk == null? null: UserVisitGroupDetailFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
196        
197        return entity;
198    }
199    
200    public UserVisitGroupDetail getLastDetail(EntityPermission entityPermission) {
201        return getLastDetail(ThreadSession.currentSession(), entityPermission);
202    }
203    
204    public UserVisitGroupDetail getLastDetail(Session session) {
205        return getLastDetail(session, EntityPermission.READ_ONLY);
206    }
207    
208    public UserVisitGroupDetail getLastDetail() {
209        return getLastDetail(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
210    }
211    
212    public UserVisitGroupDetail getLastDetailForUpdate(Session session) {
213        return getLastDetail(session, EntityPermission.READ_WRITE);
214    }
215    
216    public UserVisitGroupDetail getLastDetailForUpdate() {
217        return getLastDetail(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
218    }
219    
220    public void setLastDetailPK(UserVisitGroupDetailPK lastDetailPK)
221            throws PersistenceNotNullException, PersistenceReadOnlyException {
222        checkReadWrite();
223        _value.setLastDetailPK(lastDetailPK);
224    }
225    
226    public void setLastDetail(UserVisitGroupDetail entity) {
227        setLastDetailPK(entity == null? null: entity.getPrimaryKey());
228    }
229    
230    public boolean getLastDetailPKHasBeenModified() {
231        return _value.getLastDetailPKHasBeenModified();
232    }
233    
234}