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 * UserVisitSearch.java
021 */
022
023package com.echothree.model.data.search.server.entity;
024
025import com.echothree.model.data.search.common.pk.UserVisitSearchPK;
026
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.model.data.search.common.pk.SearchTypePK;
029import com.echothree.model.data.search.common.pk.SearchPK;
030
031import com.echothree.model.data.user.server.entity.UserVisit;
032import com.echothree.model.data.search.server.entity.SearchType;
033import com.echothree.model.data.search.server.entity.Search;
034
035import com.echothree.model.data.user.server.factory.UserVisitFactory;
036import com.echothree.model.data.search.server.factory.SearchTypeFactory;
037import com.echothree.model.data.search.server.factory.SearchFactory;
038
039import com.echothree.model.data.search.common.pk.UserVisitSearchPK;
040
041import com.echothree.model.data.search.server.value.UserVisitSearchValue;
042
043import com.echothree.model.data.search.server.factory.UserVisitSearchFactory;
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 UserVisitSearch
062        extends BaseEntity
063        implements Serializable {
064    
065    private UserVisitSearchPK _pk;
066    private UserVisitSearchValue _value;
067    
068    /** Creates a new instance of UserVisitSearch */
069    public UserVisitSearch()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of UserVisitSearch */
075    public UserVisitSearch(UserVisitSearchValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public UserVisitSearchFactory getBaseFactoryInstance() {
084        return UserVisitSearchFactory.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 UserVisitSearch that) {
108            UserVisitSearchValue thatValue = that.getUserVisitSearchValue();
109            return _value.equals(thatValue);
110        } else {
111            return false;
112        }
113    }
114    
115    @Override
116    public void store(Session session)
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().store(session, this);
119    }
120    
121    @Override
122    public void remove(Session session)
123            throws PersistenceDatabaseException {
124        getBaseFactoryInstance().remove(session, this);
125    }
126    
127    @Override
128    public void remove()
129            throws PersistenceDatabaseException {
130        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
131    }
132    
133    public UserVisitSearchValue getUserVisitSearchValue() {
134        return _value;
135    }
136    
137    public void setUserVisitSearchValue(UserVisitSearchValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    public UserVisitSearchPK getPrimaryKey() {
145        return _pk;
146    }
147    
148    public UserVisitPK getUserVisitPK() {
149        return _value.getUserVisitPK();
150    }
151    
152    public UserVisit getUserVisit(Session session, EntityPermission entityPermission) {
153        return UserVisitFactory.getInstance().getEntityFromPK(session, entityPermission, getUserVisitPK());
154    }
155    
156    public UserVisit getUserVisit(EntityPermission entityPermission) {
157        return getUserVisit(ThreadSession.currentSession(), entityPermission);
158    }
159    
160    public UserVisit getUserVisit(Session session) {
161        return getUserVisit(session, EntityPermission.READ_ONLY);
162    }
163    
164    public UserVisit getUserVisit() {
165        return getUserVisit(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
166    }
167    
168    public UserVisit getUserVisitForUpdate(Session session) {
169        return getUserVisit(session, EntityPermission.READ_WRITE);
170    }
171    
172    public UserVisit getUserVisitForUpdate() {
173        return getUserVisit(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
174    }
175    
176    public void setUserVisitPK(UserVisitPK userVisitPK)
177            throws PersistenceNotNullException, PersistenceReadOnlyException {
178        checkReadWrite();
179        _value.setUserVisitPK(userVisitPK);
180    }
181    
182    public void setUserVisit(UserVisit entity) {
183        setUserVisitPK(entity == null? null: entity.getPrimaryKey());
184    }
185    
186    public boolean getUserVisitPKHasBeenModified() {
187        return _value.getUserVisitPKHasBeenModified();
188    }
189    
190    public SearchTypePK getSearchTypePK() {
191        return _value.getSearchTypePK();
192    }
193    
194    public SearchType getSearchType(Session session, EntityPermission entityPermission) {
195        return SearchTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getSearchTypePK());
196    }
197    
198    public SearchType getSearchType(EntityPermission entityPermission) {
199        return getSearchType(ThreadSession.currentSession(), entityPermission);
200    }
201    
202    public SearchType getSearchType(Session session) {
203        return getSearchType(session, EntityPermission.READ_ONLY);
204    }
205    
206    public SearchType getSearchType() {
207        return getSearchType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
208    }
209    
210    public SearchType getSearchTypeForUpdate(Session session) {
211        return getSearchType(session, EntityPermission.READ_WRITE);
212    }
213    
214    public SearchType getSearchTypeForUpdate() {
215        return getSearchType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
216    }
217    
218    public void setSearchTypePK(SearchTypePK searchTypePK)
219            throws PersistenceNotNullException, PersistenceReadOnlyException {
220        checkReadWrite();
221        _value.setSearchTypePK(searchTypePK);
222    }
223    
224    public void setSearchType(SearchType entity) {
225        setSearchTypePK(entity == null? null: entity.getPrimaryKey());
226    }
227    
228    public boolean getSearchTypePKHasBeenModified() {
229        return _value.getSearchTypePKHasBeenModified();
230    }
231    
232    public SearchPK getSearchPK() {
233        return _value.getSearchPK();
234    }
235    
236    public Search getSearch(Session session, EntityPermission entityPermission) {
237        return SearchFactory.getInstance().getEntityFromPK(session, entityPermission, getSearchPK());
238    }
239    
240    public Search getSearch(EntityPermission entityPermission) {
241        return getSearch(ThreadSession.currentSession(), entityPermission);
242    }
243    
244    public Search getSearch(Session session) {
245        return getSearch(session, EntityPermission.READ_ONLY);
246    }
247    
248    public Search getSearch() {
249        return getSearch(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
250    }
251    
252    public Search getSearchForUpdate(Session session) {
253        return getSearch(session, EntityPermission.READ_WRITE);
254    }
255    
256    public Search getSearchForUpdate() {
257        return getSearch(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
258    }
259    
260    public void setSearchPK(SearchPK searchPK)
261            throws PersistenceNotNullException, PersistenceReadOnlyException {
262        checkReadWrite();
263        _value.setSearchPK(searchPK);
264    }
265    
266    public void setSearch(Search entity) {
267        setSearchPK(entity == null? null: entity.getPrimaryKey());
268    }
269    
270    public boolean getSearchPKHasBeenModified() {
271        return _value.getSearchPKHasBeenModified();
272    }
273    
274}