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 * 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
058public class CachedExecutedSearchResult
059        extends BaseEntity
060        implements Serializable {
061    
062    private CachedExecutedSearchResultPK _pk;
063    private CachedExecutedSearchResultValue _value;
064    
065    /** Creates a new instance of CachedExecutedSearchResult */
066    public CachedExecutedSearchResult()
067            throws PersistenceException {
068        super();
069    }
070    
071    /** Creates a new instance of CachedExecutedSearchResult */
072    public CachedExecutedSearchResult(CachedExecutedSearchResultValue value, EntityPermission entityPermission) {
073        super(entityPermission);
074        
075        _value = value;
076        _pk = value.getPrimaryKey();
077    }
078    
079    @Override
080    public CachedExecutedSearchResultFactory getBaseFactoryInstance() {
081        return CachedExecutedSearchResultFactory.getInstance();
082    }
083    
084    @Override
085    public boolean hasBeenModified() {
086        return _value.hasBeenModified();
087    }
088    
089    @Override
090    public int hashCode() {
091        return _pk.hashCode();
092    }
093    
094    @Override
095    public String toString() {
096        return _pk.toString();
097    }
098    
099    @Override
100    public boolean equals(Object other) {
101        if(this == other)
102            return true;
103        
104        if(other instanceof CachedExecutedSearchResult) {
105            CachedExecutedSearchResult that = (CachedExecutedSearchResult)other;
106            
107            CachedExecutedSearchResultValue thatValue = that.getCachedExecutedSearchResultValue();
108            return _value.equals(thatValue);
109        } else {
110            return false;
111        }
112    }
113    
114    @Override
115    public void store(Session session)
116            throws PersistenceDatabaseException {
117        getBaseFactoryInstance().store(session, this);
118    }
119    
120    @Override
121    public void remove(Session session)
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().remove(session, this);
124    }
125    
126    @Override
127    public void remove()
128            throws PersistenceDatabaseException {
129        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
130    }
131    
132    public CachedExecutedSearchResultValue getCachedExecutedSearchResultValue() {
133        return _value;
134    }
135    
136    public void setCachedExecutedSearchResultValue(CachedExecutedSearchResultValue value)
137            throws PersistenceReadOnlyException {
138        checkReadWrite();
139        _value = value;
140    }
141    
142    @Override
143    public CachedExecutedSearchResultPK getPrimaryKey() {
144        return _pk;
145    }
146    
147    public CachedExecutedSearchPK getCachedExecutedSearchPK() {
148        return _value.getCachedExecutedSearchPK();
149    }
150    
151    public CachedExecutedSearch getCachedExecutedSearch(Session session, EntityPermission entityPermission) {
152        return CachedExecutedSearchFactory.getInstance().getEntityFromPK(session, entityPermission, getCachedExecutedSearchPK());
153    }
154    
155    public CachedExecutedSearch getCachedExecutedSearch(EntityPermission entityPermission) {
156        return getCachedExecutedSearch(ThreadSession.currentSession(), entityPermission);
157    }
158    
159    public CachedExecutedSearch getCachedExecutedSearch(Session session) {
160        return getCachedExecutedSearch(session, EntityPermission.READ_ONLY);
161    }
162    
163    public CachedExecutedSearch getCachedExecutedSearch() {
164        return getCachedExecutedSearch(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
165    }
166    
167    public CachedExecutedSearch getCachedExecutedSearchForUpdate(Session session) {
168        return getCachedExecutedSearch(session, EntityPermission.READ_WRITE);
169    }
170    
171    public CachedExecutedSearch getCachedExecutedSearchForUpdate() {
172        return getCachedExecutedSearch(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
173    }
174    
175    public void setCachedExecutedSearchPK(CachedExecutedSearchPK cachedExecutedSearchPK)
176            throws PersistenceNotNullException, PersistenceReadOnlyException {
177        checkReadWrite();
178        _value.setCachedExecutedSearchPK(cachedExecutedSearchPK);
179    }
180    
181    public void setCachedExecutedSearch(CachedExecutedSearch entity) {
182        setCachedExecutedSearchPK(entity == null? null: entity.getPrimaryKey());
183    }
184    
185    public boolean getCachedExecutedSearchPKHasBeenModified() {
186        return _value.getCachedExecutedSearchPKHasBeenModified();
187    }
188    
189    public EntityInstancePK getEntityInstancePK() {
190        return _value.getEntityInstancePK();
191    }
192    
193    public EntityInstance getEntityInstance(Session session, EntityPermission entityPermission) {
194        return EntityInstanceFactory.getInstance().getEntityFromPK(session, entityPermission, getEntityInstancePK());
195    }
196    
197    public EntityInstance getEntityInstance(EntityPermission entityPermission) {
198        return getEntityInstance(ThreadSession.currentSession(), entityPermission);
199    }
200    
201    public EntityInstance getEntityInstance(Session session) {
202        return getEntityInstance(session, EntityPermission.READ_ONLY);
203    }
204    
205    public EntityInstance getEntityInstance() {
206        return getEntityInstance(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
207    }
208    
209    public EntityInstance getEntityInstanceForUpdate(Session session) {
210        return getEntityInstance(session, EntityPermission.READ_WRITE);
211    }
212    
213    public EntityInstance getEntityInstanceForUpdate() {
214        return getEntityInstance(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
215    }
216    
217    public void setEntityInstancePK(EntityInstancePK entityInstancePK)
218            throws PersistenceNotNullException, PersistenceReadOnlyException {
219        checkReadWrite();
220        _value.setEntityInstancePK(entityInstancePK);
221    }
222    
223    public void setEntityInstance(EntityInstance entity) {
224        setEntityInstancePK(entity == null? null: entity.getPrimaryKey());
225    }
226    
227    public boolean getEntityInstancePKHasBeenModified() {
228        return _value.getEntityInstancePKHasBeenModified();
229    }
230    
231    public Integer getSortOrder() {
232        return _value.getSortOrder();
233    }
234    
235    public void setSortOrder(Integer sortOrder)
236            throws PersistenceNotNullException, PersistenceReadOnlyException {
237        checkReadWrite();
238        _value.setSortOrder(sortOrder);
239    }
240    
241    public boolean getSortOrderHasBeenModified() {
242        return _value.getSortOrderHasBeenModified();
243    }
244    
245}