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 * CachedSearchIndexField.java
021 */
022
023package com.echothree.model.data.search.server.entity;
024
025import com.echothree.model.data.search.common.pk.CachedSearchIndexFieldPK;
026
027import com.echothree.model.data.search.common.pk.CachedSearchPK;
028import com.echothree.model.data.index.common.pk.IndexFieldPK;
029
030import com.echothree.model.data.search.server.entity.CachedSearch;
031import com.echothree.model.data.index.server.entity.IndexField;
032
033import com.echothree.model.data.search.server.factory.CachedSearchFactory;
034import com.echothree.model.data.index.server.factory.IndexFieldFactory;
035
036import com.echothree.model.data.search.common.pk.CachedSearchIndexFieldPK;
037
038import com.echothree.model.data.search.server.value.CachedSearchIndexFieldValue;
039
040import com.echothree.model.data.search.server.factory.CachedSearchIndexFieldFactory;
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 CachedSearchIndexField
059        extends BaseEntity
060        implements Serializable {
061    
062    private CachedSearchIndexFieldPK _pk;
063    private CachedSearchIndexFieldValue _value;
064    
065    /** Creates a new instance of CachedSearchIndexField */
066    public CachedSearchIndexField()
067            throws PersistenceException {
068        super();
069    }
070    
071    /** Creates a new instance of CachedSearchIndexField */
072    public CachedSearchIndexField(CachedSearchIndexFieldValue value, EntityPermission entityPermission) {
073        super(entityPermission);
074        
075        _value = value;
076        _pk = value.getPrimaryKey();
077    }
078    
079    @Override
080    public CachedSearchIndexFieldFactory getBaseFactoryInstance() {
081        return CachedSearchIndexFieldFactory.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 CachedSearchIndexField that) {
105            CachedSearchIndexFieldValue thatValue = that.getCachedSearchIndexFieldValue();
106            return _value.equals(thatValue);
107        } else {
108            return false;
109        }
110    }
111    
112    @Override
113    public void store()
114            throws PersistenceDatabaseException {
115        getBaseFactoryInstance().store(this);
116    }
117    
118    @Override
119    public void remove()
120            throws PersistenceDatabaseException {
121        getBaseFactoryInstance().remove(this);
122    }
123    
124    public CachedSearchIndexFieldValue getCachedSearchIndexFieldValue() {
125        return _value;
126    }
127    
128    public void setCachedSearchIndexFieldValue(CachedSearchIndexFieldValue value)
129            throws PersistenceReadOnlyException {
130        checkReadWrite();
131        _value = value;
132    }
133    
134    @Override
135    public CachedSearchIndexFieldPK getPrimaryKey() {
136        return _pk;
137    }
138    
139    public CachedSearchPK getCachedSearchPK() {
140        return _value.getCachedSearchPK();
141    }
142    
143    public CachedSearch getCachedSearch(EntityPermission entityPermission) {
144        return CachedSearchFactory.getInstance().getEntityFromPK(entityPermission, getCachedSearchPK());
145    }
146    
147    public CachedSearch getCachedSearch() {
148        return getCachedSearch(EntityPermission.READ_ONLY);
149    }
150    
151    public CachedSearch getCachedSearchForUpdate() {
152        return getCachedSearch(EntityPermission.READ_WRITE);
153    }
154    
155    public void setCachedSearchPK(CachedSearchPK cachedSearchPK)
156            throws PersistenceNotNullException, PersistenceReadOnlyException {
157        checkReadWrite();
158        _value.setCachedSearchPK(cachedSearchPK);
159    }
160    
161    public void setCachedSearch(CachedSearch entity) {
162        setCachedSearchPK(entity == null? null: entity.getPrimaryKey());
163    }
164    
165    public boolean getCachedSearchPKHasBeenModified() {
166        return _value.getCachedSearchPKHasBeenModified();
167    }
168    
169    public IndexFieldPK getIndexFieldPK() {
170        return _value.getIndexFieldPK();
171    }
172    
173    public IndexField getIndexField(EntityPermission entityPermission) {
174        return IndexFieldFactory.getInstance().getEntityFromPK(entityPermission, getIndexFieldPK());
175    }
176    
177    public IndexField getIndexField() {
178        return getIndexField(EntityPermission.READ_ONLY);
179    }
180    
181    public IndexField getIndexFieldForUpdate() {
182        return getIndexField(EntityPermission.READ_WRITE);
183    }
184    
185    public void setIndexFieldPK(IndexFieldPK indexFieldPK)
186            throws PersistenceNotNullException, PersistenceReadOnlyException {
187        checkReadWrite();
188        _value.setIndexFieldPK(indexFieldPK);
189    }
190    
191    public void setIndexField(IndexField entity) {
192        setIndexFieldPK(entity == null? null: entity.getPrimaryKey());
193    }
194    
195    public boolean getIndexFieldPKHasBeenModified() {
196        return _value.getIndexFieldPKHasBeenModified();
197    }
198    
199    public Long getFromTime() {
200        return _value.getFromTime();
201    }
202    
203    public void setFromTime(Long fromTime)
204            throws PersistenceNotNullException, PersistenceReadOnlyException {
205        checkReadWrite();
206        _value.setFromTime(fromTime);
207    }
208    
209    public boolean getFromTimeHasBeenModified() {
210        return _value.getFromTimeHasBeenModified();
211    }
212    
213    public Long getThruTime() {
214        return _value.getThruTime();
215    }
216    
217    public void setThruTime(Long thruTime)
218            throws PersistenceNotNullException, PersistenceReadOnlyException {
219        checkReadWrite();
220        _value.setThruTime(thruTime);
221    }
222    
223    public boolean getThruTimeHasBeenModified() {
224        return _value.getThruTimeHasBeenModified();
225    }
226    
227}