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 * 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
061import javax.annotation.Nonnull;
062import javax.annotation.Nullable;
063
064public class UserVisitSearch
065        extends BaseEntity
066        implements Serializable {
067    
068    private UserVisitSearchPK _pk;
069    private UserVisitSearchValue _value;
070    
071    /** Creates a new instance of UserVisitSearch */
072    public UserVisitSearch()
073            throws PersistenceException {
074        super();
075    }
076    
077    /** Creates a new instance of UserVisitSearch */
078    public UserVisitSearch(UserVisitSearchValue value, EntityPermission entityPermission) {
079        super(entityPermission);
080        
081        _value = value;
082        _pk = value.getPrimaryKey();
083    }
084    
085    @Override
086    @Nonnull
087    public UserVisitSearchFactory getBaseFactoryInstance() {
088        return UserVisitSearchFactory.getInstance();
089    }
090    
091    @Override
092    public boolean hasBeenModified() {
093        return _value.hasBeenModified();
094    }
095    
096    @Override
097    public int hashCode() {
098        return _pk.hashCode();
099    }
100    
101    @Override
102    @Nonnull
103    public String toString() {
104        return _pk.toString();
105    }
106    
107    @Override
108    public boolean equals(Object other) {
109        if(this == other)
110            return true;
111        
112        if(other instanceof UserVisitSearch that) {
113            UserVisitSearchValue thatValue = that.getUserVisitSearchValue();
114            return _value.equals(thatValue);
115        } else {
116            return false;
117        }
118    }
119    
120    @Override
121    public void store()
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().store(this);
124    }
125    
126    @Override
127    public void remove()
128            throws PersistenceDatabaseException {
129        getBaseFactoryInstance().remove(this);
130    }
131    
132    @Nonnull
133    public UserVisitSearchValue getUserVisitSearchValue() {
134        return _value;
135    }
136    
137    public void setUserVisitSearchValue(@Nonnull UserVisitSearchValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    @Nonnull
145    public UserVisitSearchPK getPrimaryKey() {
146        return _pk;
147    }
148    
149    @Nonnull
150    public UserVisitPK getUserVisitPK() {
151        return _value.getUserVisitPK();
152    }
153    
154    @Nonnull
155    public UserVisit getUserVisit(EntityPermission entityPermission) {
156        return UserVisitFactory.getInstance().getEntityFromPK(entityPermission, getUserVisitPK());
157    }
158    
159    @Nonnull
160    public UserVisit getUserVisit() {
161        return getUserVisit(EntityPermission.READ_ONLY);
162    }
163    
164    @Nonnull
165    public UserVisit getUserVisitForUpdate() {
166        return getUserVisit(EntityPermission.READ_WRITE);
167    }
168    
169    public void setUserVisitPK(@Nonnull UserVisitPK userVisitPK)
170            throws PersistenceNotNullException, PersistenceReadOnlyException {
171        checkReadWrite();
172        _value.setUserVisitPK(userVisitPK);
173    }
174    
175    public void setUserVisit(@Nonnull UserVisit entity) {
176        setUserVisitPK(entity == null ? null : entity.getPrimaryKey());
177    }
178    
179    public boolean getUserVisitPKHasBeenModified() {
180        return _value.getUserVisitPKHasBeenModified();
181    }
182    
183    @Nonnull
184    public SearchTypePK getSearchTypePK() {
185        return _value.getSearchTypePK();
186    }
187    
188    @Nonnull
189    public SearchType getSearchType(EntityPermission entityPermission) {
190        return SearchTypeFactory.getInstance().getEntityFromPK(entityPermission, getSearchTypePK());
191    }
192    
193    @Nonnull
194    public SearchType getSearchType() {
195        return getSearchType(EntityPermission.READ_ONLY);
196    }
197    
198    @Nonnull
199    public SearchType getSearchTypeForUpdate() {
200        return getSearchType(EntityPermission.READ_WRITE);
201    }
202    
203    public void setSearchTypePK(@Nonnull SearchTypePK searchTypePK)
204            throws PersistenceNotNullException, PersistenceReadOnlyException {
205        checkReadWrite();
206        _value.setSearchTypePK(searchTypePK);
207    }
208    
209    public void setSearchType(@Nonnull SearchType entity) {
210        setSearchTypePK(entity == null ? null : entity.getPrimaryKey());
211    }
212    
213    public boolean getSearchTypePKHasBeenModified() {
214        return _value.getSearchTypePKHasBeenModified();
215    }
216    
217    @Nonnull
218    public SearchPK getSearchPK() {
219        return _value.getSearchPK();
220    }
221    
222    @Nonnull
223    public Search getSearch(EntityPermission entityPermission) {
224        return SearchFactory.getInstance().getEntityFromPK(entityPermission, getSearchPK());
225    }
226    
227    @Nonnull
228    public Search getSearch() {
229        return getSearch(EntityPermission.READ_ONLY);
230    }
231    
232    @Nonnull
233    public Search getSearchForUpdate() {
234        return getSearch(EntityPermission.READ_WRITE);
235    }
236    
237    public void setSearchPK(@Nonnull SearchPK searchPK)
238            throws PersistenceNotNullException, PersistenceReadOnlyException {
239        checkReadWrite();
240        _value.setSearchPK(searchPK);
241    }
242    
243    public void setSearch(@Nonnull Search entity) {
244        setSearchPK(entity == null ? null : entity.getPrimaryKey());
245    }
246    
247    public boolean getSearchPKHasBeenModified() {
248        return _value.getSearchPKHasBeenModified();
249    }
250    
251}