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 * CachedSearch.java
021 */
022
023package com.echothree.model.data.search.server.entity;
024
025import com.echothree.model.data.search.common.pk.CachedSearchPK;
026
027import com.echothree.model.data.index.common.pk.IndexPK;
028import com.echothree.model.data.search.common.pk.SearchDefaultOperatorPK;
029import com.echothree.model.data.search.common.pk.SearchSortOrderPK;
030import com.echothree.model.data.search.common.pk.SearchSortDirectionPK;
031
032import com.echothree.model.data.index.server.entity.Index;
033import com.echothree.model.data.search.server.entity.SearchDefaultOperator;
034import com.echothree.model.data.search.server.entity.SearchSortOrder;
035import com.echothree.model.data.search.server.entity.SearchSortDirection;
036
037import com.echothree.model.data.index.server.factory.IndexFactory;
038import com.echothree.model.data.search.server.factory.SearchDefaultOperatorFactory;
039import com.echothree.model.data.search.server.factory.SearchSortOrderFactory;
040import com.echothree.model.data.search.server.factory.SearchSortDirectionFactory;
041
042import com.echothree.model.data.search.common.pk.CachedSearchPK;
043
044import com.echothree.model.data.search.server.value.CachedSearchValue;
045
046import com.echothree.model.data.search.server.factory.CachedSearchFactory;
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 CachedSearch
065        extends BaseEntity
066        implements Serializable {
067    
068    private CachedSearchPK _pk;
069    private CachedSearchValue _value;
070    
071    /** Creates a new instance of CachedSearch */
072    public CachedSearch()
073            throws PersistenceException {
074        super();
075    }
076    
077    /** Creates a new instance of CachedSearch */
078    public CachedSearch(CachedSearchValue value, EntityPermission entityPermission) {
079        super(entityPermission);
080        
081        _value = value;
082        _pk = value.getPrimaryKey();
083    }
084    
085    @Override
086    public CachedSearchFactory getBaseFactoryInstance() {
087        return CachedSearchFactory.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 CachedSearch that) {
111            CachedSearchValue thatValue = that.getCachedSearchValue();
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 CachedSearchValue getCachedSearchValue() {
137        return _value;
138    }
139    
140    public void setCachedSearchValue(CachedSearchValue value)
141            throws PersistenceReadOnlyException {
142        checkReadWrite();
143        _value = value;
144    }
145    
146    @Override
147    public CachedSearchPK getPrimaryKey() {
148        return _pk;
149    }
150    
151    public IndexPK getIndexPK() {
152        return _value.getIndexPK();
153    }
154    
155    public Index getIndex(Session session, EntityPermission entityPermission) {
156        return IndexFactory.getInstance().getEntityFromPK(session, entityPermission, getIndexPK());
157    }
158    
159    public Index getIndex(EntityPermission entityPermission) {
160        return getIndex(ThreadSession.currentSession(), entityPermission);
161    }
162    
163    public Index getIndex(Session session) {
164        return getIndex(session, EntityPermission.READ_ONLY);
165    }
166    
167    public Index getIndex() {
168        return getIndex(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
169    }
170    
171    public Index getIndexForUpdate(Session session) {
172        return getIndex(session, EntityPermission.READ_WRITE);
173    }
174    
175    public Index getIndexForUpdate() {
176        return getIndex(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
177    }
178    
179    public void setIndexPK(IndexPK indexPK)
180            throws PersistenceNotNullException, PersistenceReadOnlyException {
181        checkReadWrite();
182        _value.setIndexPK(indexPK);
183    }
184    
185    public void setIndex(Index entity) {
186        setIndexPK(entity == null? null: entity.getPrimaryKey());
187    }
188    
189    public boolean getIndexPKHasBeenModified() {
190        return _value.getIndexPKHasBeenModified();
191    }
192    
193    public String getQuerySha1Hash() {
194        return _value.getQuerySha1Hash();
195    }
196    
197    public void setQuerySha1Hash(String querySha1Hash)
198            throws PersistenceNotNullException, PersistenceReadOnlyException {
199        checkReadWrite();
200        _value.setQuerySha1Hash(querySha1Hash);
201    }
202    
203    public boolean getQuerySha1HashHasBeenModified() {
204        return _value.getQuerySha1HashHasBeenModified();
205    }
206    
207    public String getQuery() {
208        return _value.getQuery();
209    }
210    
211    public void setQuery(String query)
212            throws PersistenceNotNullException, PersistenceReadOnlyException {
213        checkReadWrite();
214        _value.setQuery(query);
215    }
216    
217    public boolean getQueryHasBeenModified() {
218        return _value.getQueryHasBeenModified();
219    }
220    
221    public String getParsedQuerySha1Hash() {
222        return _value.getParsedQuerySha1Hash();
223    }
224    
225    public void setParsedQuerySha1Hash(String parsedQuerySha1Hash)
226            throws PersistenceNotNullException, PersistenceReadOnlyException {
227        checkReadWrite();
228        _value.setParsedQuerySha1Hash(parsedQuerySha1Hash);
229    }
230    
231    public boolean getParsedQuerySha1HashHasBeenModified() {
232        return _value.getParsedQuerySha1HashHasBeenModified();
233    }
234    
235    public String getParsedQuery() {
236        return _value.getParsedQuery();
237    }
238    
239    public void setParsedQuery(String parsedQuery)
240            throws PersistenceNotNullException, PersistenceReadOnlyException {
241        checkReadWrite();
242        _value.setParsedQuery(parsedQuery);
243    }
244    
245    public boolean getParsedQueryHasBeenModified() {
246        return _value.getParsedQueryHasBeenModified();
247    }
248    
249    public SearchDefaultOperatorPK getSearchDefaultOperatorPK() {
250        return _value.getSearchDefaultOperatorPK();
251    }
252    
253    public SearchDefaultOperator getSearchDefaultOperator(Session session, EntityPermission entityPermission) {
254        return SearchDefaultOperatorFactory.getInstance().getEntityFromPK(session, entityPermission, getSearchDefaultOperatorPK());
255    }
256    
257    public SearchDefaultOperator getSearchDefaultOperator(EntityPermission entityPermission) {
258        return getSearchDefaultOperator(ThreadSession.currentSession(), entityPermission);
259    }
260    
261    public SearchDefaultOperator getSearchDefaultOperator(Session session) {
262        return getSearchDefaultOperator(session, EntityPermission.READ_ONLY);
263    }
264    
265    public SearchDefaultOperator getSearchDefaultOperator() {
266        return getSearchDefaultOperator(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
267    }
268    
269    public SearchDefaultOperator getSearchDefaultOperatorForUpdate(Session session) {
270        return getSearchDefaultOperator(session, EntityPermission.READ_WRITE);
271    }
272    
273    public SearchDefaultOperator getSearchDefaultOperatorForUpdate() {
274        return getSearchDefaultOperator(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
275    }
276    
277    public void setSearchDefaultOperatorPK(SearchDefaultOperatorPK searchDefaultOperatorPK)
278            throws PersistenceNotNullException, PersistenceReadOnlyException {
279        checkReadWrite();
280        _value.setSearchDefaultOperatorPK(searchDefaultOperatorPK);
281    }
282    
283    public void setSearchDefaultOperator(SearchDefaultOperator entity) {
284        setSearchDefaultOperatorPK(entity == null? null: entity.getPrimaryKey());
285    }
286    
287    public boolean getSearchDefaultOperatorPKHasBeenModified() {
288        return _value.getSearchDefaultOperatorPKHasBeenModified();
289    }
290    
291    public SearchSortOrderPK getSearchSortOrderPK() {
292        return _value.getSearchSortOrderPK();
293    }
294    
295    public SearchSortOrder getSearchSortOrder(Session session, EntityPermission entityPermission) {
296        return SearchSortOrderFactory.getInstance().getEntityFromPK(session, entityPermission, getSearchSortOrderPK());
297    }
298    
299    public SearchSortOrder getSearchSortOrder(EntityPermission entityPermission) {
300        return getSearchSortOrder(ThreadSession.currentSession(), entityPermission);
301    }
302    
303    public SearchSortOrder getSearchSortOrder(Session session) {
304        return getSearchSortOrder(session, EntityPermission.READ_ONLY);
305    }
306    
307    public SearchSortOrder getSearchSortOrder() {
308        return getSearchSortOrder(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
309    }
310    
311    public SearchSortOrder getSearchSortOrderForUpdate(Session session) {
312        return getSearchSortOrder(session, EntityPermission.READ_WRITE);
313    }
314    
315    public SearchSortOrder getSearchSortOrderForUpdate() {
316        return getSearchSortOrder(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
317    }
318    
319    public void setSearchSortOrderPK(SearchSortOrderPK searchSortOrderPK)
320            throws PersistenceNotNullException, PersistenceReadOnlyException {
321        checkReadWrite();
322        _value.setSearchSortOrderPK(searchSortOrderPK);
323    }
324    
325    public void setSearchSortOrder(SearchSortOrder entity) {
326        setSearchSortOrderPK(entity == null? null: entity.getPrimaryKey());
327    }
328    
329    public boolean getSearchSortOrderPKHasBeenModified() {
330        return _value.getSearchSortOrderPKHasBeenModified();
331    }
332    
333    public SearchSortDirectionPK getSearchSortDirectionPK() {
334        return _value.getSearchSortDirectionPK();
335    }
336    
337    public SearchSortDirection getSearchSortDirection(Session session, EntityPermission entityPermission) {
338        return SearchSortDirectionFactory.getInstance().getEntityFromPK(session, entityPermission, getSearchSortDirectionPK());
339    }
340    
341    public SearchSortDirection getSearchSortDirection(EntityPermission entityPermission) {
342        return getSearchSortDirection(ThreadSession.currentSession(), entityPermission);
343    }
344    
345    public SearchSortDirection getSearchSortDirection(Session session) {
346        return getSearchSortDirection(session, EntityPermission.READ_ONLY);
347    }
348    
349    public SearchSortDirection getSearchSortDirection() {
350        return getSearchSortDirection(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
351    }
352    
353    public SearchSortDirection getSearchSortDirectionForUpdate(Session session) {
354        return getSearchSortDirection(session, EntityPermission.READ_WRITE);
355    }
356    
357    public SearchSortDirection getSearchSortDirectionForUpdate() {
358        return getSearchSortDirection(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
359    }
360    
361    public void setSearchSortDirectionPK(SearchSortDirectionPK searchSortDirectionPK)
362            throws PersistenceNotNullException, PersistenceReadOnlyException {
363        checkReadWrite();
364        _value.setSearchSortDirectionPK(searchSortDirectionPK);
365    }
366    
367    public void setSearchSortDirection(SearchSortDirection entity) {
368        setSearchSortDirectionPK(entity == null? null: entity.getPrimaryKey());
369    }
370    
371    public boolean getSearchSortDirectionPKHasBeenModified() {
372        return _value.getSearchSortDirectionPKHasBeenModified();
373    }
374    
375    public Long getFromTime() {
376        return _value.getFromTime();
377    }
378    
379    public void setFromTime(Long fromTime)
380            throws PersistenceNotNullException, PersistenceReadOnlyException {
381        checkReadWrite();
382        _value.setFromTime(fromTime);
383    }
384    
385    public boolean getFromTimeHasBeenModified() {
386        return _value.getFromTimeHasBeenModified();
387    }
388    
389    public Long getThruTime() {
390        return _value.getThruTime();
391    }
392    
393    public void setThruTime(Long thruTime)
394            throws PersistenceNotNullException, PersistenceReadOnlyException {
395        checkReadWrite();
396        _value.setThruTime(thruTime);
397    }
398    
399    public boolean getThruTimeHasBeenModified() {
400        return _value.getThruTimeHasBeenModified();
401    }
402    
403}