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 * CachedExecutedSearchResult.java
021 */
022
023package com.echothree.model.data.search.server.entity;
024
025import com.echothree.model.data.search.common.pk.CachedExecutedSearchResultPK;
026
027import com.echothree.model.data.search.common.pk.CachedExecutedSearchPK;
028import com.echothree.model.data.core.common.pk.EntityInstancePK;
029
030import com.echothree.model.data.search.server.entity.CachedExecutedSearch;
031import com.echothree.model.data.core.server.entity.EntityInstance;
032
033import com.echothree.model.data.search.server.factory.CachedExecutedSearchFactory;
034import com.echothree.model.data.core.server.factory.EntityInstanceFactory;
035
036import com.echothree.model.data.search.common.pk.CachedExecutedSearchResultPK;
037
038import com.echothree.model.data.search.server.value.CachedExecutedSearchResultValue;
039
040import com.echothree.model.data.search.server.factory.CachedExecutedSearchResultFactory;
041
042import com.echothree.util.common.exception.PersistenceException;
043import com.echothree.util.common.exception.PersistenceDatabaseException;
044import com.echothree.util.common.exception.PersistenceNotNullException;
045import com.echothree.util.common.exception.PersistenceReadOnlyException;
046
047import com.echothree.util.common.persistence.BasePK;
048
049import com.echothree.util.common.persistence.type.ByteArray;
050
051import com.echothree.util.server.persistence.BaseEntity;
052import com.echothree.util.server.persistence.EntityPermission;
053import com.echothree.util.server.persistence.Session;
054import com.echothree.util.server.persistence.ThreadSession;
055
056import java.io.Serializable;
057
058import javax.annotation.Nonnull;
059import javax.annotation.Nullable;
060
061public class CachedExecutedSearchResult
062        extends BaseEntity
063        implements Serializable {
064    
065    private CachedExecutedSearchResultPK _pk;
066    private CachedExecutedSearchResultValue _value;
067    
068    /** Creates a new instance of CachedExecutedSearchResult */
069    public CachedExecutedSearchResult()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of CachedExecutedSearchResult */
075    public CachedExecutedSearchResult(CachedExecutedSearchResultValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    @Nonnull
084    public CachedExecutedSearchResultFactory getBaseFactoryInstance() {
085        return CachedExecutedSearchResultFactory.getInstance();
086    }
087    
088    @Override
089    public boolean hasBeenModified() {
090        return _value.hasBeenModified();
091    }
092    
093    @Override
094    public int hashCode() {
095        return _pk.hashCode();
096    }
097    
098    @Override
099    @Nonnull
100    public String toString() {
101        return _pk.toString();
102    }
103    
104    @Override
105    public boolean equals(Object other) {
106        if(this == other)
107            return true;
108        
109        if(other instanceof CachedExecutedSearchResult that) {
110            CachedExecutedSearchResultValue thatValue = that.getCachedExecutedSearchResultValue();
111            return _value.equals(thatValue);
112        } else {
113            return false;
114        }
115    }
116    
117    @Override
118    public void store()
119            throws PersistenceDatabaseException {
120        getBaseFactoryInstance().store(this);
121    }
122    
123    @Override
124    public void remove()
125            throws PersistenceDatabaseException {
126        getBaseFactoryInstance().remove(this);
127    }
128    
129    @Nonnull
130    public CachedExecutedSearchResultValue getCachedExecutedSearchResultValue() {
131        return _value;
132    }
133    
134    public void setCachedExecutedSearchResultValue(@Nonnull CachedExecutedSearchResultValue value)
135            throws PersistenceReadOnlyException {
136        checkReadWrite();
137        _value = value;
138    }
139    
140    @Override
141    @Nonnull
142    public CachedExecutedSearchResultPK getPrimaryKey() {
143        return _pk;
144    }
145    
146    @Nonnull
147    public CachedExecutedSearchPK getCachedExecutedSearchPK() {
148        return _value.getCachedExecutedSearchPK();
149    }
150    
151    @Nonnull
152    public CachedExecutedSearch getCachedExecutedSearch(EntityPermission entityPermission) {
153        return CachedExecutedSearchFactory.getInstance().getEntityFromPK(entityPermission, getCachedExecutedSearchPK());
154    }
155    
156    @Nonnull
157    public CachedExecutedSearch getCachedExecutedSearch() {
158        return getCachedExecutedSearch(EntityPermission.READ_ONLY);
159    }
160    
161    @Nonnull
162    public CachedExecutedSearch getCachedExecutedSearchForUpdate() {
163        return getCachedExecutedSearch(EntityPermission.READ_WRITE);
164    }
165    
166    public void setCachedExecutedSearchPK(@Nonnull CachedExecutedSearchPK cachedExecutedSearchPK)
167            throws PersistenceNotNullException, PersistenceReadOnlyException {
168        checkReadWrite();
169        _value.setCachedExecutedSearchPK(cachedExecutedSearchPK);
170    }
171    
172    public void setCachedExecutedSearch(@Nonnull CachedExecutedSearch entity) {
173        setCachedExecutedSearchPK(entity == null ? null : entity.getPrimaryKey());
174    }
175    
176    public boolean getCachedExecutedSearchPKHasBeenModified() {
177        return _value.getCachedExecutedSearchPKHasBeenModified();
178    }
179    
180    @Nonnull
181    public EntityInstancePK getEntityInstancePK() {
182        return _value.getEntityInstancePK();
183    }
184    
185    @Nonnull
186    public EntityInstance getEntityInstance(EntityPermission entityPermission) {
187        return EntityInstanceFactory.getInstance().getEntityFromPK(entityPermission, getEntityInstancePK());
188    }
189    
190    @Nonnull
191    public EntityInstance getEntityInstance() {
192        return getEntityInstance(EntityPermission.READ_ONLY);
193    }
194    
195    @Nonnull
196    public EntityInstance getEntityInstanceForUpdate() {
197        return getEntityInstance(EntityPermission.READ_WRITE);
198    }
199    
200    public void setEntityInstancePK(@Nonnull EntityInstancePK entityInstancePK)
201            throws PersistenceNotNullException, PersistenceReadOnlyException {
202        checkReadWrite();
203        _value.setEntityInstancePK(entityInstancePK);
204    }
205    
206    public void setEntityInstance(@Nonnull EntityInstance entity) {
207        setEntityInstancePK(entity == null ? null : entity.getPrimaryKey());
208    }
209    
210    public boolean getEntityInstancePKHasBeenModified() {
211        return _value.getEntityInstancePKHasBeenModified();
212    }
213    
214    @Nonnull
215    public Integer getSortOrder() {
216        return _value.getSortOrder();
217    }
218    
219    public void setSortOrder(@Nonnull Integer sortOrder)
220            throws PersistenceNotNullException, PersistenceReadOnlyException {
221        checkReadWrite();
222        _value.setSortOrder(sortOrder);
223    }
224    
225    public boolean getSortOrderHasBeenModified() {
226        return _value.getSortOrderHasBeenModified();
227    }
228    
229}