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 * Search.java
021 */
022
023package com.echothree.model.data.search.server.entity;
024
025import com.echothree.model.data.search.common.pk.SearchPK;
026
027import com.echothree.model.data.party.common.pk.PartyPK;
028import com.echothree.model.data.search.common.pk.SearchTypePK;
029import com.echothree.model.data.search.common.pk.SearchUseTypePK;
030import com.echothree.model.data.search.common.pk.CachedSearchPK;
031
032import com.echothree.model.data.party.server.entity.Party;
033import com.echothree.model.data.search.server.entity.SearchType;
034import com.echothree.model.data.search.server.entity.SearchUseType;
035import com.echothree.model.data.search.server.entity.CachedSearch;
036
037import com.echothree.model.data.party.server.factory.PartyFactory;
038import com.echothree.model.data.search.server.factory.SearchTypeFactory;
039import com.echothree.model.data.search.server.factory.SearchUseTypeFactory;
040import com.echothree.model.data.search.server.factory.CachedSearchFactory;
041
042import com.echothree.model.data.search.common.pk.SearchPK;
043
044import com.echothree.model.data.search.server.value.SearchValue;
045
046import com.echothree.model.data.search.server.factory.SearchFactory;
047
048import com.echothree.util.common.exception.PersistenceException;
049import com.echothree.util.common.exception.PersistenceDatabaseException;
050import com.echothree.util.common.exception.PersistenceNotNullException;
051import com.echothree.util.common.exception.PersistenceReadOnlyException;
052
053import com.echothree.util.common.persistence.BasePK;
054
055import com.echothree.util.common.persistence.type.ByteArray;
056
057import com.echothree.util.server.persistence.BaseEntity;
058import com.echothree.util.server.persistence.EntityPermission;
059import com.echothree.util.server.persistence.Session;
060import com.echothree.util.server.persistence.ThreadSession;
061
062import java.io.Serializable;
063
064public class Search
065        extends BaseEntity
066        implements Serializable {
067    
068    private SearchPK _pk;
069    private SearchValue _value;
070    
071    /** Creates a new instance of Search */
072    public Search()
073            throws PersistenceException {
074        super();
075    }
076    
077    /** Creates a new instance of Search */
078    public Search(SearchValue value, EntityPermission entityPermission) {
079        super(entityPermission);
080        
081        _value = value;
082        _pk = value.getPrimaryKey();
083    }
084    
085    @Override
086    public SearchFactory getBaseFactoryInstance() {
087        return SearchFactory.getInstance();
088    }
089    
090    @Override
091    public boolean hasBeenModified() {
092        return _value.hasBeenModified();
093    }
094    
095    @Override
096    public int hashCode() {
097        return _pk.hashCode();
098    }
099    
100    @Override
101    public String toString() {
102        return _pk.toString();
103    }
104    
105    @Override
106    public boolean equals(Object other) {
107        if(this == other)
108            return true;
109        
110        if(other instanceof Search that) {
111            SearchValue thatValue = that.getSearchValue();
112            return _value.equals(thatValue);
113        } else {
114            return false;
115        }
116    }
117    
118    @Override
119    public void store(Session session)
120            throws PersistenceDatabaseException {
121        getBaseFactoryInstance().store(session, this);
122    }
123    
124    @Override
125    public void remove(Session session)
126            throws PersistenceDatabaseException {
127        getBaseFactoryInstance().remove(session, this);
128    }
129    
130    @Override
131    public void remove()
132            throws PersistenceDatabaseException {
133        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
134    }
135    
136    public SearchValue getSearchValue() {
137        return _value;
138    }
139    
140    public void setSearchValue(SearchValue value)
141            throws PersistenceReadOnlyException {
142        checkReadWrite();
143        _value = value;
144    }
145    
146    @Override
147    public SearchPK getPrimaryKey() {
148        return _pk;
149    }
150    
151    public PartyPK getPartyPK() {
152        return _value.getPartyPK();
153    }
154    
155    public Party getParty(Session session, EntityPermission entityPermission) {
156        PartyPK pk = getPartyPK();
157        Party entity = pk == null? null: PartyFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
158        
159        return entity;
160    }
161    
162    public Party getParty(EntityPermission entityPermission) {
163        return getParty(ThreadSession.currentSession(), entityPermission);
164    }
165    
166    public Party getParty(Session session) {
167        return getParty(session, EntityPermission.READ_ONLY);
168    }
169    
170    public Party getParty() {
171        return getParty(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
172    }
173    
174    public Party getPartyForUpdate(Session session) {
175        return getParty(session, EntityPermission.READ_WRITE);
176    }
177    
178    public Party getPartyForUpdate() {
179        return getParty(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
180    }
181    
182    public void setPartyPK(PartyPK partyPK)
183            throws PersistenceNotNullException, PersistenceReadOnlyException {
184        checkReadWrite();
185        _value.setPartyPK(partyPK);
186    }
187    
188    public void setParty(Party entity) {
189        setPartyPK(entity == null? null: entity.getPrimaryKey());
190    }
191    
192    public boolean getPartyPKHasBeenModified() {
193        return _value.getPartyPKHasBeenModified();
194    }
195    
196    public Boolean getPartyVerified() {
197        return _value.getPartyVerified();
198    }
199    
200    public void setPartyVerified(Boolean partyVerified)
201            throws PersistenceNotNullException, PersistenceReadOnlyException {
202        checkReadWrite();
203        _value.setPartyVerified(partyVerified);
204    }
205    
206    public boolean getPartyVerifiedHasBeenModified() {
207        return _value.getPartyVerifiedHasBeenModified();
208    }
209    
210    public SearchTypePK getSearchTypePK() {
211        return _value.getSearchTypePK();
212    }
213    
214    public SearchType getSearchType(Session session, EntityPermission entityPermission) {
215        return SearchTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getSearchTypePK());
216    }
217    
218    public SearchType getSearchType(EntityPermission entityPermission) {
219        return getSearchType(ThreadSession.currentSession(), entityPermission);
220    }
221    
222    public SearchType getSearchType(Session session) {
223        return getSearchType(session, EntityPermission.READ_ONLY);
224    }
225    
226    public SearchType getSearchType() {
227        return getSearchType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
228    }
229    
230    public SearchType getSearchTypeForUpdate(Session session) {
231        return getSearchType(session, EntityPermission.READ_WRITE);
232    }
233    
234    public SearchType getSearchTypeForUpdate() {
235        return getSearchType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
236    }
237    
238    public void setSearchTypePK(SearchTypePK searchTypePK)
239            throws PersistenceNotNullException, PersistenceReadOnlyException {
240        checkReadWrite();
241        _value.setSearchTypePK(searchTypePK);
242    }
243    
244    public void setSearchType(SearchType entity) {
245        setSearchTypePK(entity == null? null: entity.getPrimaryKey());
246    }
247    
248    public boolean getSearchTypePKHasBeenModified() {
249        return _value.getSearchTypePKHasBeenModified();
250    }
251    
252    public Long getExecutedTime() {
253        return _value.getExecutedTime();
254    }
255    
256    public void setExecutedTime(Long executedTime)
257            throws PersistenceNotNullException, PersistenceReadOnlyException {
258        checkReadWrite();
259        _value.setExecutedTime(executedTime);
260    }
261    
262    public boolean getExecutedTimeHasBeenModified() {
263        return _value.getExecutedTimeHasBeenModified();
264    }
265    
266    public SearchUseTypePK getSearchUseTypePK() {
267        return _value.getSearchUseTypePK();
268    }
269    
270    public SearchUseType getSearchUseType(Session session, EntityPermission entityPermission) {
271        SearchUseTypePK pk = getSearchUseTypePK();
272        SearchUseType entity = pk == null? null: SearchUseTypeFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
273        
274        return entity;
275    }
276    
277    public SearchUseType getSearchUseType(EntityPermission entityPermission) {
278        return getSearchUseType(ThreadSession.currentSession(), entityPermission);
279    }
280    
281    public SearchUseType getSearchUseType(Session session) {
282        return getSearchUseType(session, EntityPermission.READ_ONLY);
283    }
284    
285    public SearchUseType getSearchUseType() {
286        return getSearchUseType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
287    }
288    
289    public SearchUseType getSearchUseTypeForUpdate(Session session) {
290        return getSearchUseType(session, EntityPermission.READ_WRITE);
291    }
292    
293    public SearchUseType getSearchUseTypeForUpdate() {
294        return getSearchUseType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
295    }
296    
297    public void setSearchUseTypePK(SearchUseTypePK searchUseTypePK)
298            throws PersistenceNotNullException, PersistenceReadOnlyException {
299        checkReadWrite();
300        _value.setSearchUseTypePK(searchUseTypePK);
301    }
302    
303    public void setSearchUseType(SearchUseType entity) {
304        setSearchUseTypePK(entity == null? null: entity.getPrimaryKey());
305    }
306    
307    public boolean getSearchUseTypePKHasBeenModified() {
308        return _value.getSearchUseTypePKHasBeenModified();
309    }
310    
311    public CachedSearchPK getCachedSearchPK() {
312        return _value.getCachedSearchPK();
313    }
314    
315    public CachedSearch getCachedSearch(Session session, EntityPermission entityPermission) {
316        CachedSearchPK pk = getCachedSearchPK();
317        CachedSearch entity = pk == null? null: CachedSearchFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
318        
319        return entity;
320    }
321    
322    public CachedSearch getCachedSearch(EntityPermission entityPermission) {
323        return getCachedSearch(ThreadSession.currentSession(), entityPermission);
324    }
325    
326    public CachedSearch getCachedSearch(Session session) {
327        return getCachedSearch(session, EntityPermission.READ_ONLY);
328    }
329    
330    public CachedSearch getCachedSearch() {
331        return getCachedSearch(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
332    }
333    
334    public CachedSearch getCachedSearchForUpdate(Session session) {
335        return getCachedSearch(session, EntityPermission.READ_WRITE);
336    }
337    
338    public CachedSearch getCachedSearchForUpdate() {
339        return getCachedSearch(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
340    }
341    
342    public void setCachedSearchPK(CachedSearchPK cachedSearchPK)
343            throws PersistenceNotNullException, PersistenceReadOnlyException {
344        checkReadWrite();
345        _value.setCachedSearchPK(cachedSearchPK);
346    }
347    
348    public void setCachedSearch(CachedSearch entity) {
349        setCachedSearchPK(entity == null? null: entity.getPrimaryKey());
350    }
351    
352    public boolean getCachedSearchPKHasBeenModified() {
353        return _value.getCachedSearchPKHasBeenModified();
354    }
355    
356    public Long getFromTime() {
357        return _value.getFromTime();
358    }
359    
360    public void setFromTime(Long fromTime)
361            throws PersistenceNotNullException, PersistenceReadOnlyException {
362        checkReadWrite();
363        _value.setFromTime(fromTime);
364    }
365    
366    public boolean getFromTimeHasBeenModified() {
367        return _value.getFromTimeHasBeenModified();
368    }
369    
370    public Long getThruTime() {
371        return _value.getThruTime();
372    }
373    
374    public void setThruTime(Long thruTime)
375            throws PersistenceNotNullException, PersistenceReadOnlyException {
376        checkReadWrite();
377        _value.setThruTime(thruTime);
378    }
379    
380    public boolean getThruTimeHasBeenModified() {
381        return _value.getThruTimeHasBeenModified();
382    }
383    
384}