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 * SearchResultAction.java
021 */
022
023package com.echothree.model.data.search.server.entity;
024
025import com.echothree.model.data.search.common.pk.SearchResultActionPK;
026
027import com.echothree.model.data.search.common.pk.SearchPK;
028import com.echothree.model.data.search.common.pk.SearchResultActionTypePK;
029import com.echothree.model.data.core.common.pk.EntityInstancePK;
030
031import com.echothree.model.data.search.server.entity.Search;
032import com.echothree.model.data.search.server.entity.SearchResultActionType;
033import com.echothree.model.data.core.server.entity.EntityInstance;
034
035import com.echothree.model.data.search.server.factory.SearchFactory;
036import com.echothree.model.data.search.server.factory.SearchResultActionTypeFactory;
037import com.echothree.model.data.core.server.factory.EntityInstanceFactory;
038
039import com.echothree.model.data.search.common.pk.SearchResultActionPK;
040
041import com.echothree.model.data.search.server.value.SearchResultActionValue;
042
043import com.echothree.model.data.search.server.factory.SearchResultActionFactory;
044
045import com.echothree.util.common.exception.PersistenceException;
046import com.echothree.util.common.exception.PersistenceDatabaseException;
047import com.echothree.util.common.exception.PersistenceNotNullException;
048import com.echothree.util.common.exception.PersistenceReadOnlyException;
049
050import com.echothree.util.common.persistence.BasePK;
051
052import com.echothree.util.common.persistence.type.ByteArray;
053
054import com.echothree.util.server.persistence.BaseEntity;
055import com.echothree.util.server.persistence.EntityPermission;
056import com.echothree.util.server.persistence.Session;
057import com.echothree.util.server.persistence.ThreadSession;
058
059import java.io.Serializable;
060
061public class SearchResultAction
062        extends BaseEntity
063        implements Serializable {
064    
065    private SearchResultActionPK _pk;
066    private SearchResultActionValue _value;
067    
068    /** Creates a new instance of SearchResultAction */
069    public SearchResultAction()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of SearchResultAction */
075    public SearchResultAction(SearchResultActionValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public SearchResultActionFactory getBaseFactoryInstance() {
084        return SearchResultActionFactory.getInstance();
085    }
086    
087    @Override
088    public boolean hasBeenModified() {
089        return _value.hasBeenModified();
090    }
091    
092    @Override
093    public int hashCode() {
094        return _pk.hashCode();
095    }
096    
097    @Override
098    public String toString() {
099        return _pk.toString();
100    }
101    
102    @Override
103    public boolean equals(Object other) {
104        if(this == other)
105            return true;
106        
107        if(other instanceof SearchResultAction) {
108            SearchResultAction that = (SearchResultAction)other;
109            
110            SearchResultActionValue thatValue = that.getSearchResultActionValue();
111            return _value.equals(thatValue);
112        } else {
113            return false;
114        }
115    }
116    
117    @Override
118    public void store(Session session)
119            throws PersistenceDatabaseException {
120        getBaseFactoryInstance().store(session, this);
121    }
122    
123    @Override
124    public void remove(Session session)
125            throws PersistenceDatabaseException {
126        getBaseFactoryInstance().remove(session, this);
127    }
128    
129    @Override
130    public void remove()
131            throws PersistenceDatabaseException {
132        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
133    }
134    
135    public SearchResultActionValue getSearchResultActionValue() {
136        return _value;
137    }
138    
139    public void setSearchResultActionValue(SearchResultActionValue value)
140            throws PersistenceReadOnlyException {
141        checkReadWrite();
142        _value = value;
143    }
144    
145    @Override
146    public SearchResultActionPK getPrimaryKey() {
147        return _pk;
148    }
149    
150    public SearchPK getSearchPK() {
151        return _value.getSearchPK();
152    }
153    
154    public Search getSearch(Session session, EntityPermission entityPermission) {
155        return SearchFactory.getInstance().getEntityFromPK(session, entityPermission, getSearchPK());
156    }
157    
158    public Search getSearch(EntityPermission entityPermission) {
159        return getSearch(ThreadSession.currentSession(), entityPermission);
160    }
161    
162    public Search getSearch(Session session) {
163        return getSearch(session, EntityPermission.READ_ONLY);
164    }
165    
166    public Search getSearch() {
167        return getSearch(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
168    }
169    
170    public Search getSearchForUpdate(Session session) {
171        return getSearch(session, EntityPermission.READ_WRITE);
172    }
173    
174    public Search getSearchForUpdate() {
175        return getSearch(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
176    }
177    
178    public void setSearchPK(SearchPK searchPK)
179            throws PersistenceNotNullException, PersistenceReadOnlyException {
180        checkReadWrite();
181        _value.setSearchPK(searchPK);
182    }
183    
184    public void setSearch(Search entity) {
185        setSearchPK(entity == null? null: entity.getPrimaryKey());
186    }
187    
188    public boolean getSearchPKHasBeenModified() {
189        return _value.getSearchPKHasBeenModified();
190    }
191    
192    public SearchResultActionTypePK getSearchResultActionTypePK() {
193        return _value.getSearchResultActionTypePK();
194    }
195    
196    public SearchResultActionType getSearchResultActionType(Session session, EntityPermission entityPermission) {
197        return SearchResultActionTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getSearchResultActionTypePK());
198    }
199    
200    public SearchResultActionType getSearchResultActionType(EntityPermission entityPermission) {
201        return getSearchResultActionType(ThreadSession.currentSession(), entityPermission);
202    }
203    
204    public SearchResultActionType getSearchResultActionType(Session session) {
205        return getSearchResultActionType(session, EntityPermission.READ_ONLY);
206    }
207    
208    public SearchResultActionType getSearchResultActionType() {
209        return getSearchResultActionType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
210    }
211    
212    public SearchResultActionType getSearchResultActionTypeForUpdate(Session session) {
213        return getSearchResultActionType(session, EntityPermission.READ_WRITE);
214    }
215    
216    public SearchResultActionType getSearchResultActionTypeForUpdate() {
217        return getSearchResultActionType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
218    }
219    
220    public void setSearchResultActionTypePK(SearchResultActionTypePK searchResultActionTypePK)
221            throws PersistenceNotNullException, PersistenceReadOnlyException {
222        checkReadWrite();
223        _value.setSearchResultActionTypePK(searchResultActionTypePK);
224    }
225    
226    public void setSearchResultActionType(SearchResultActionType entity) {
227        setSearchResultActionTypePK(entity == null? null: entity.getPrimaryKey());
228    }
229    
230    public boolean getSearchResultActionTypePKHasBeenModified() {
231        return _value.getSearchResultActionTypePKHasBeenModified();
232    }
233    
234    public Long getActionTime() {
235        return _value.getActionTime();
236    }
237    
238    public void setActionTime(Long actionTime)
239            throws PersistenceNotNullException, PersistenceReadOnlyException {
240        checkReadWrite();
241        _value.setActionTime(actionTime);
242    }
243    
244    public boolean getActionTimeHasBeenModified() {
245        return _value.getActionTimeHasBeenModified();
246    }
247    
248    public EntityInstancePK getEntityInstancePK() {
249        return _value.getEntityInstancePK();
250    }
251    
252    public EntityInstance getEntityInstance(Session session, EntityPermission entityPermission) {
253        return EntityInstanceFactory.getInstance().getEntityFromPK(session, entityPermission, getEntityInstancePK());
254    }
255    
256    public EntityInstance getEntityInstance(EntityPermission entityPermission) {
257        return getEntityInstance(ThreadSession.currentSession(), entityPermission);
258    }
259    
260    public EntityInstance getEntityInstance(Session session) {
261        return getEntityInstance(session, EntityPermission.READ_ONLY);
262    }
263    
264    public EntityInstance getEntityInstance() {
265        return getEntityInstance(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
266    }
267    
268    public EntityInstance getEntityInstanceForUpdate(Session session) {
269        return getEntityInstance(session, EntityPermission.READ_WRITE);
270    }
271    
272    public EntityInstance getEntityInstanceForUpdate() {
273        return getEntityInstance(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
274    }
275    
276    public void setEntityInstancePK(EntityInstancePK entityInstancePK)
277            throws PersistenceNotNullException, PersistenceReadOnlyException {
278        checkReadWrite();
279        _value.setEntityInstancePK(entityInstancePK);
280    }
281    
282    public void setEntityInstance(EntityInstance entity) {
283        setEntityInstancePK(entity == null? null: entity.getPrimaryKey());
284    }
285    
286    public boolean getEntityInstancePKHasBeenModified() {
287        return _value.getEntityInstancePKHasBeenModified();
288    }
289    
290    public Long getFromTime() {
291        return _value.getFromTime();
292    }
293    
294    public void setFromTime(Long fromTime)
295            throws PersistenceNotNullException, PersistenceReadOnlyException {
296        checkReadWrite();
297        _value.setFromTime(fromTime);
298    }
299    
300    public boolean getFromTimeHasBeenModified() {
301        return _value.getFromTimeHasBeenModified();
302    }
303    
304    public Long getThruTime() {
305        return _value.getThruTime();
306    }
307    
308    public void setThruTime(Long thruTime)
309            throws PersistenceNotNullException, PersistenceReadOnlyException {
310        checkReadWrite();
311        _value.setThruTime(thruTime);
312    }
313    
314    public boolean getThruTimeHasBeenModified() {
315        return _value.getThruTimeHasBeenModified();
316    }
317    
318}