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 * Search.java
021 */
022
023package com.echothree.model.data.search.server.entity;
024
025import com.echothree.model.data.search.common.pk.SearchPK;
026
027import com.echothree.model.data.party.common.pk.PartyPK;
028import com.echothree.model.data.search.common.pk.SearchTypePK;
029import com.echothree.model.data.search.common.pk.SearchUseTypePK;
030import com.echothree.model.data.search.common.pk.CachedSearchPK;
031
032import com.echothree.model.data.party.server.entity.Party;
033import com.echothree.model.data.search.server.entity.SearchType;
034import com.echothree.model.data.search.server.entity.SearchUseType;
035import com.echothree.model.data.search.server.entity.CachedSearch;
036
037import com.echothree.model.data.party.server.factory.PartyFactory;
038import com.echothree.model.data.search.server.factory.SearchTypeFactory;
039import com.echothree.model.data.search.server.factory.SearchUseTypeFactory;
040import com.echothree.model.data.search.server.factory.CachedSearchFactory;
041
042import com.echothree.model.data.search.common.pk.SearchPK;
043
044import com.echothree.model.data.search.server.value.SearchValue;
045
046import com.echothree.model.data.search.server.factory.SearchFactory;
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 Search
065        extends BaseEntity
066        implements Serializable {
067    
068    private SearchPK _pk;
069    private SearchValue _value;
070    
071    /** Creates a new instance of Search */
072    public Search()
073            throws PersistenceException {
074        super();
075    }
076    
077    /** Creates a new instance of Search */
078    public Search(SearchValue value, EntityPermission entityPermission) {
079        super(entityPermission);
080        
081        _value = value;
082        _pk = value.getPrimaryKey();
083    }
084    
085    @Override
086    public SearchFactory getBaseFactoryInstance() {
087        return SearchFactory.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 Search) {
111            Search that = (Search)other;
112            
113            SearchValue thatValue = that.getSearchValue();
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 SearchValue getSearchValue() {
139        return _value;
140    }
141    
142    public void setSearchValue(SearchValue value)
143            throws PersistenceReadOnlyException {
144        checkReadWrite();
145        _value = value;
146    }
147    
148    @Override
149    public SearchPK getPrimaryKey() {
150        return _pk;
151    }
152    
153    public PartyPK getPartyPK() {
154        return _value.getPartyPK();
155    }
156    
157    public Party getParty(Session session, EntityPermission entityPermission) {
158        PartyPK pk = getPartyPK();
159        Party entity = pk == null? null: PartyFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
160        
161        return entity;
162    }
163    
164    public Party getParty(EntityPermission entityPermission) {
165        return getParty(ThreadSession.currentSession(), entityPermission);
166    }
167    
168    public Party getParty(Session session) {
169        return getParty(session, EntityPermission.READ_ONLY);
170    }
171    
172    public Party getParty() {
173        return getParty(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
174    }
175    
176    public Party getPartyForUpdate(Session session) {
177        return getParty(session, EntityPermission.READ_WRITE);
178    }
179    
180    public Party getPartyForUpdate() {
181        return getParty(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
182    }
183    
184    public void setPartyPK(PartyPK partyPK)
185            throws PersistenceNotNullException, PersistenceReadOnlyException {
186        checkReadWrite();
187        _value.setPartyPK(partyPK);
188    }
189    
190    public void setParty(Party entity) {
191        setPartyPK(entity == null? null: entity.getPrimaryKey());
192    }
193    
194    public boolean getPartyPKHasBeenModified() {
195        return _value.getPartyPKHasBeenModified();
196    }
197    
198    public Boolean getPartyVerified() {
199        return _value.getPartyVerified();
200    }
201    
202    public void setPartyVerified(Boolean partyVerified)
203            throws PersistenceNotNullException, PersistenceReadOnlyException {
204        checkReadWrite();
205        _value.setPartyVerified(partyVerified);
206    }
207    
208    public boolean getPartyVerifiedHasBeenModified() {
209        return _value.getPartyVerifiedHasBeenModified();
210    }
211    
212    public SearchTypePK getSearchTypePK() {
213        return _value.getSearchTypePK();
214    }
215    
216    public SearchType getSearchType(Session session, EntityPermission entityPermission) {
217        return SearchTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getSearchTypePK());
218    }
219    
220    public SearchType getSearchType(EntityPermission entityPermission) {
221        return getSearchType(ThreadSession.currentSession(), entityPermission);
222    }
223    
224    public SearchType getSearchType(Session session) {
225        return getSearchType(session, EntityPermission.READ_ONLY);
226    }
227    
228    public SearchType getSearchType() {
229        return getSearchType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
230    }
231    
232    public SearchType getSearchTypeForUpdate(Session session) {
233        return getSearchType(session, EntityPermission.READ_WRITE);
234    }
235    
236    public SearchType getSearchTypeForUpdate() {
237        return getSearchType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
238    }
239    
240    public void setSearchTypePK(SearchTypePK searchTypePK)
241            throws PersistenceNotNullException, PersistenceReadOnlyException {
242        checkReadWrite();
243        _value.setSearchTypePK(searchTypePK);
244    }
245    
246    public void setSearchType(SearchType entity) {
247        setSearchTypePK(entity == null? null: entity.getPrimaryKey());
248    }
249    
250    public boolean getSearchTypePKHasBeenModified() {
251        return _value.getSearchTypePKHasBeenModified();
252    }
253    
254    public Long getExecutedTime() {
255        return _value.getExecutedTime();
256    }
257    
258    public void setExecutedTime(Long executedTime)
259            throws PersistenceNotNullException, PersistenceReadOnlyException {
260        checkReadWrite();
261        _value.setExecutedTime(executedTime);
262    }
263    
264    public boolean getExecutedTimeHasBeenModified() {
265        return _value.getExecutedTimeHasBeenModified();
266    }
267    
268    public SearchUseTypePK getSearchUseTypePK() {
269        return _value.getSearchUseTypePK();
270    }
271    
272    public SearchUseType getSearchUseType(Session session, EntityPermission entityPermission) {
273        SearchUseTypePK pk = getSearchUseTypePK();
274        SearchUseType entity = pk == null? null: SearchUseTypeFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
275        
276        return entity;
277    }
278    
279    public SearchUseType getSearchUseType(EntityPermission entityPermission) {
280        return getSearchUseType(ThreadSession.currentSession(), entityPermission);
281    }
282    
283    public SearchUseType getSearchUseType(Session session) {
284        return getSearchUseType(session, EntityPermission.READ_ONLY);
285    }
286    
287    public SearchUseType getSearchUseType() {
288        return getSearchUseType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
289    }
290    
291    public SearchUseType getSearchUseTypeForUpdate(Session session) {
292        return getSearchUseType(session, EntityPermission.READ_WRITE);
293    }
294    
295    public SearchUseType getSearchUseTypeForUpdate() {
296        return getSearchUseType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
297    }
298    
299    public void setSearchUseTypePK(SearchUseTypePK searchUseTypePK)
300            throws PersistenceNotNullException, PersistenceReadOnlyException {
301        checkReadWrite();
302        _value.setSearchUseTypePK(searchUseTypePK);
303    }
304    
305    public void setSearchUseType(SearchUseType entity) {
306        setSearchUseTypePK(entity == null? null: entity.getPrimaryKey());
307    }
308    
309    public boolean getSearchUseTypePKHasBeenModified() {
310        return _value.getSearchUseTypePKHasBeenModified();
311    }
312    
313    public CachedSearchPK getCachedSearchPK() {
314        return _value.getCachedSearchPK();
315    }
316    
317    public CachedSearch getCachedSearch(Session session, EntityPermission entityPermission) {
318        CachedSearchPK pk = getCachedSearchPK();
319        CachedSearch entity = pk == null? null: CachedSearchFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
320        
321        return entity;
322    }
323    
324    public CachedSearch getCachedSearch(EntityPermission entityPermission) {
325        return getCachedSearch(ThreadSession.currentSession(), entityPermission);
326    }
327    
328    public CachedSearch getCachedSearch(Session session) {
329        return getCachedSearch(session, EntityPermission.READ_ONLY);
330    }
331    
332    public CachedSearch getCachedSearch() {
333        return getCachedSearch(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
334    }
335    
336    public CachedSearch getCachedSearchForUpdate(Session session) {
337        return getCachedSearch(session, EntityPermission.READ_WRITE);
338    }
339    
340    public CachedSearch getCachedSearchForUpdate() {
341        return getCachedSearch(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
342    }
343    
344    public void setCachedSearchPK(CachedSearchPK cachedSearchPK)
345            throws PersistenceNotNullException, PersistenceReadOnlyException {
346        checkReadWrite();
347        _value.setCachedSearchPK(cachedSearchPK);
348    }
349    
350    public void setCachedSearch(CachedSearch entity) {
351        setCachedSearchPK(entity == null? null: entity.getPrimaryKey());
352    }
353    
354    public boolean getCachedSearchPKHasBeenModified() {
355        return _value.getCachedSearchPKHasBeenModified();
356    }
357    
358    public Long getFromTime() {
359        return _value.getFromTime();
360    }
361    
362    public void setFromTime(Long fromTime)
363            throws PersistenceNotNullException, PersistenceReadOnlyException {
364        checkReadWrite();
365        _value.setFromTime(fromTime);
366    }
367    
368    public boolean getFromTimeHasBeenModified() {
369        return _value.getFromTimeHasBeenModified();
370    }
371    
372    public Long getThruTime() {
373        return _value.getThruTime();
374    }
375    
376    public void setThruTime(Long thruTime)
377            throws PersistenceNotNullException, PersistenceReadOnlyException {
378        checkReadWrite();
379        _value.setThruTime(thruTime);
380    }
381    
382    public boolean getThruTimeHasBeenModified() {
383        return _value.getThruTimeHasBeenModified();
384    }
385    
386}