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 * 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) {
111            CachedSearch that = (CachedSearch)other;
112            
113            CachedSearchValue thatValue = that.getCachedSearchValue();
114            return _value.equals(thatValue);
115        } else {
116            return false;
117        }
118    }
119    
120    @Override
121    public void store(Session session)
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().store(session, this);
124    }
125    
126    @Override
127    public void remove(Session session)
128            throws PersistenceDatabaseException {
129        getBaseFactoryInstance().remove(session, this);
130    }
131    
132    @Override
133    public void remove()
134            throws PersistenceDatabaseException {
135        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
136    }
137    
138    public CachedSearchValue getCachedSearchValue() {
139        return _value;
140    }
141    
142    public void setCachedSearchValue(CachedSearchValue value)
143            throws PersistenceReadOnlyException {
144        checkReadWrite();
145        _value = value;
146    }
147    
148    @Override
149    public CachedSearchPK getPrimaryKey() {
150        return _pk;
151    }
152    
153    public IndexPK getIndexPK() {
154        return _value.getIndexPK();
155    }
156    
157    public Index getIndex(Session session, EntityPermission entityPermission) {
158        return IndexFactory.getInstance().getEntityFromPK(session, entityPermission, getIndexPK());
159    }
160    
161    public Index getIndex(EntityPermission entityPermission) {
162        return getIndex(ThreadSession.currentSession(), entityPermission);
163    }
164    
165    public Index getIndex(Session session) {
166        return getIndex(session, EntityPermission.READ_ONLY);
167    }
168    
169    public Index getIndex() {
170        return getIndex(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
171    }
172    
173    public Index getIndexForUpdate(Session session) {
174        return getIndex(session, EntityPermission.READ_WRITE);
175    }
176    
177    public Index getIndexForUpdate() {
178        return getIndex(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
179    }
180    
181    public void setIndexPK(IndexPK indexPK)
182            throws PersistenceNotNullException, PersistenceReadOnlyException {
183        checkReadWrite();
184        _value.setIndexPK(indexPK);
185    }
186    
187    public void setIndex(Index entity) {
188        setIndexPK(entity == null? null: entity.getPrimaryKey());
189    }
190    
191    public boolean getIndexPKHasBeenModified() {
192        return _value.getIndexPKHasBeenModified();
193    }
194    
195    public String getQuerySha1Hash() {
196        return _value.getQuerySha1Hash();
197    }
198    
199    public void setQuerySha1Hash(String querySha1Hash)
200            throws PersistenceNotNullException, PersistenceReadOnlyException {
201        checkReadWrite();
202        _value.setQuerySha1Hash(querySha1Hash);
203    }
204    
205    public boolean getQuerySha1HashHasBeenModified() {
206        return _value.getQuerySha1HashHasBeenModified();
207    }
208    
209    public String getQuery() {
210        return _value.getQuery();
211    }
212    
213    public void setQuery(String query)
214            throws PersistenceNotNullException, PersistenceReadOnlyException {
215        checkReadWrite();
216        _value.setQuery(query);
217    }
218    
219    public boolean getQueryHasBeenModified() {
220        return _value.getQueryHasBeenModified();
221    }
222    
223    public String getParsedQuerySha1Hash() {
224        return _value.getParsedQuerySha1Hash();
225    }
226    
227    public void setParsedQuerySha1Hash(String parsedQuerySha1Hash)
228            throws PersistenceNotNullException, PersistenceReadOnlyException {
229        checkReadWrite();
230        _value.setParsedQuerySha1Hash(parsedQuerySha1Hash);
231    }
232    
233    public boolean getParsedQuerySha1HashHasBeenModified() {
234        return _value.getParsedQuerySha1HashHasBeenModified();
235    }
236    
237    public String getParsedQuery() {
238        return _value.getParsedQuery();
239    }
240    
241    public void setParsedQuery(String parsedQuery)
242            throws PersistenceNotNullException, PersistenceReadOnlyException {
243        checkReadWrite();
244        _value.setParsedQuery(parsedQuery);
245    }
246    
247    public boolean getParsedQueryHasBeenModified() {
248        return _value.getParsedQueryHasBeenModified();
249    }
250    
251    public SearchDefaultOperatorPK getSearchDefaultOperatorPK() {
252        return _value.getSearchDefaultOperatorPK();
253    }
254    
255    public SearchDefaultOperator getSearchDefaultOperator(Session session, EntityPermission entityPermission) {
256        return SearchDefaultOperatorFactory.getInstance().getEntityFromPK(session, entityPermission, getSearchDefaultOperatorPK());
257    }
258    
259    public SearchDefaultOperator getSearchDefaultOperator(EntityPermission entityPermission) {
260        return getSearchDefaultOperator(ThreadSession.currentSession(), entityPermission);
261    }
262    
263    public SearchDefaultOperator getSearchDefaultOperator(Session session) {
264        return getSearchDefaultOperator(session, EntityPermission.READ_ONLY);
265    }
266    
267    public SearchDefaultOperator getSearchDefaultOperator() {
268        return getSearchDefaultOperator(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
269    }
270    
271    public SearchDefaultOperator getSearchDefaultOperatorForUpdate(Session session) {
272        return getSearchDefaultOperator(session, EntityPermission.READ_WRITE);
273    }
274    
275    public SearchDefaultOperator getSearchDefaultOperatorForUpdate() {
276        return getSearchDefaultOperator(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
277    }
278    
279    public void setSearchDefaultOperatorPK(SearchDefaultOperatorPK searchDefaultOperatorPK)
280            throws PersistenceNotNullException, PersistenceReadOnlyException {
281        checkReadWrite();
282        _value.setSearchDefaultOperatorPK(searchDefaultOperatorPK);
283    }
284    
285    public void setSearchDefaultOperator(SearchDefaultOperator entity) {
286        setSearchDefaultOperatorPK(entity == null? null: entity.getPrimaryKey());
287    }
288    
289    public boolean getSearchDefaultOperatorPKHasBeenModified() {
290        return _value.getSearchDefaultOperatorPKHasBeenModified();
291    }
292    
293    public SearchSortOrderPK getSearchSortOrderPK() {
294        return _value.getSearchSortOrderPK();
295    }
296    
297    public SearchSortOrder getSearchSortOrder(Session session, EntityPermission entityPermission) {
298        return SearchSortOrderFactory.getInstance().getEntityFromPK(session, entityPermission, getSearchSortOrderPK());
299    }
300    
301    public SearchSortOrder getSearchSortOrder(EntityPermission entityPermission) {
302        return getSearchSortOrder(ThreadSession.currentSession(), entityPermission);
303    }
304    
305    public SearchSortOrder getSearchSortOrder(Session session) {
306        return getSearchSortOrder(session, EntityPermission.READ_ONLY);
307    }
308    
309    public SearchSortOrder getSearchSortOrder() {
310        return getSearchSortOrder(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
311    }
312    
313    public SearchSortOrder getSearchSortOrderForUpdate(Session session) {
314        return getSearchSortOrder(session, EntityPermission.READ_WRITE);
315    }
316    
317    public SearchSortOrder getSearchSortOrderForUpdate() {
318        return getSearchSortOrder(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
319    }
320    
321    public void setSearchSortOrderPK(SearchSortOrderPK searchSortOrderPK)
322            throws PersistenceNotNullException, PersistenceReadOnlyException {
323        checkReadWrite();
324        _value.setSearchSortOrderPK(searchSortOrderPK);
325    }
326    
327    public void setSearchSortOrder(SearchSortOrder entity) {
328        setSearchSortOrderPK(entity == null? null: entity.getPrimaryKey());
329    }
330    
331    public boolean getSearchSortOrderPKHasBeenModified() {
332        return _value.getSearchSortOrderPKHasBeenModified();
333    }
334    
335    public SearchSortDirectionPK getSearchSortDirectionPK() {
336        return _value.getSearchSortDirectionPK();
337    }
338    
339    public SearchSortDirection getSearchSortDirection(Session session, EntityPermission entityPermission) {
340        return SearchSortDirectionFactory.getInstance().getEntityFromPK(session, entityPermission, getSearchSortDirectionPK());
341    }
342    
343    public SearchSortDirection getSearchSortDirection(EntityPermission entityPermission) {
344        return getSearchSortDirection(ThreadSession.currentSession(), entityPermission);
345    }
346    
347    public SearchSortDirection getSearchSortDirection(Session session) {
348        return getSearchSortDirection(session, EntityPermission.READ_ONLY);
349    }
350    
351    public SearchSortDirection getSearchSortDirection() {
352        return getSearchSortDirection(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
353    }
354    
355    public SearchSortDirection getSearchSortDirectionForUpdate(Session session) {
356        return getSearchSortDirection(session, EntityPermission.READ_WRITE);
357    }
358    
359    public SearchSortDirection getSearchSortDirectionForUpdate() {
360        return getSearchSortDirection(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
361    }
362    
363    public void setSearchSortDirectionPK(SearchSortDirectionPK searchSortDirectionPK)
364            throws PersistenceNotNullException, PersistenceReadOnlyException {
365        checkReadWrite();
366        _value.setSearchSortDirectionPK(searchSortDirectionPK);
367    }
368    
369    public void setSearchSortDirection(SearchSortDirection entity) {
370        setSearchSortDirectionPK(entity == null? null: entity.getPrimaryKey());
371    }
372    
373    public boolean getSearchSortDirectionPKHasBeenModified() {
374        return _value.getSearchSortDirectionPKHasBeenModified();
375    }
376    
377    public Long getFromTime() {
378        return _value.getFromTime();
379    }
380    
381    public void setFromTime(Long fromTime)
382            throws PersistenceNotNullException, PersistenceReadOnlyException {
383        checkReadWrite();
384        _value.setFromTime(fromTime);
385    }
386    
387    public boolean getFromTimeHasBeenModified() {
388        return _value.getFromTimeHasBeenModified();
389    }
390    
391    public Long getThruTime() {
392        return _value.getThruTime();
393    }
394    
395    public void setThruTime(Long thruTime)
396            throws PersistenceNotNullException, PersistenceReadOnlyException {
397        checkReadWrite();
398        _value.setThruTime(thruTime);
399    }
400    
401    public boolean getThruTimeHasBeenModified() {
402        return _value.getThruTimeHasBeenModified();
403    }
404    
405}