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 * 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) {
108            UserVisitSearch that = (UserVisitSearch)other;
109            
110            UserVisitSearchValue thatValue = that.getUserVisitSearchValue();
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 UserVisitSearchValue getUserVisitSearchValue() {
136        return _value;
137    }
138    
139    public void setUserVisitSearchValue(UserVisitSearchValue value)
140            throws PersistenceReadOnlyException {
141        checkReadWrite();
142        _value = value;
143    }
144    
145    @Override
146    public UserVisitSearchPK 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 SearchTypePK getSearchTypePK() {
193        return _value.getSearchTypePK();
194    }
195    
196    public SearchType getSearchType(Session session, EntityPermission entityPermission) {
197        return SearchTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getSearchTypePK());
198    }
199    
200    public SearchType getSearchType(EntityPermission entityPermission) {
201        return getSearchType(ThreadSession.currentSession(), entityPermission);
202    }
203    
204    public SearchType getSearchType(Session session) {
205        return getSearchType(session, EntityPermission.READ_ONLY);
206    }
207    
208    public SearchType getSearchType() {
209        return getSearchType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
210    }
211    
212    public SearchType getSearchTypeForUpdate(Session session) {
213        return getSearchType(session, EntityPermission.READ_WRITE);
214    }
215    
216    public SearchType getSearchTypeForUpdate() {
217        return getSearchType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
218    }
219    
220    public void setSearchTypePK(SearchTypePK searchTypePK)
221            throws PersistenceNotNullException, PersistenceReadOnlyException {
222        checkReadWrite();
223        _value.setSearchTypePK(searchTypePK);
224    }
225    
226    public void setSearchType(SearchType entity) {
227        setSearchTypePK(entity == null? null: entity.getPrimaryKey());
228    }
229    
230    public boolean getSearchTypePKHasBeenModified() {
231        return _value.getSearchTypePKHasBeenModified();
232    }
233    
234    public SearchPK getSearchPK() {
235        return _value.getSearchPK();
236    }
237    
238    public Search getSearch(Session session, EntityPermission entityPermission) {
239        return SearchFactory.getInstance().getEntityFromPK(session, entityPermission, getSearchPK());
240    }
241    
242    public Search getSearch(EntityPermission entityPermission) {
243        return getSearch(ThreadSession.currentSession(), entityPermission);
244    }
245    
246    public Search getSearch(Session session) {
247        return getSearch(session, EntityPermission.READ_ONLY);
248    }
249    
250    public Search getSearch() {
251        return getSearch(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
252    }
253    
254    public Search getSearchForUpdate(Session session) {
255        return getSearch(session, EntityPermission.READ_WRITE);
256    }
257    
258    public Search getSearchForUpdate() {
259        return getSearch(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
260    }
261    
262    public void setSearchPK(SearchPK searchPK)
263            throws PersistenceNotNullException, PersistenceReadOnlyException {
264        checkReadWrite();
265        _value.setSearchPK(searchPK);
266    }
267    
268    public void setSearch(Search entity) {
269        setSearchPK(entity == null? null: entity.getPrimaryKey());
270    }
271    
272    public boolean getSearchPKHasBeenModified() {
273        return _value.getSearchPKHasBeenModified();
274    }
275    
276}