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 * UserVisitCommand.java
021 */
022
023package com.echothree.model.data.user.server.entity;
024
025import com.echothree.model.data.user.common.pk.UserVisitCommandPK;
026
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.model.data.party.common.pk.PartyPK;
029import com.echothree.model.data.core.common.pk.CommandPK;
030
031import com.echothree.model.data.user.server.entity.UserVisit;
032import com.echothree.model.data.party.server.entity.Party;
033import com.echothree.model.data.core.server.entity.Command;
034
035import com.echothree.model.data.user.server.factory.UserVisitFactory;
036import com.echothree.model.data.party.server.factory.PartyFactory;
037import com.echothree.model.data.core.server.factory.CommandFactory;
038
039import com.echothree.model.data.user.common.pk.UserVisitCommandPK;
040
041import com.echothree.model.data.user.server.value.UserVisitCommandValue;
042
043import com.echothree.model.data.user.server.factory.UserVisitCommandFactory;
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
061import javax.annotation.Nonnull;
062import javax.annotation.Nullable;
063
064public class UserVisitCommand
065        extends BaseEntity
066        implements Serializable {
067    
068    private UserVisitCommandPK _pk;
069    private UserVisitCommandValue _value;
070    
071    /** Creates a new instance of UserVisitCommand */
072    public UserVisitCommand()
073            throws PersistenceException {
074        super();
075    }
076    
077    /** Creates a new instance of UserVisitCommand */
078    public UserVisitCommand(UserVisitCommandValue value, EntityPermission entityPermission) {
079        super(entityPermission);
080        
081        _value = value;
082        _pk = value.getPrimaryKey();
083    }
084    
085    @Override
086    @Nonnull
087    public UserVisitCommandFactory getBaseFactoryInstance() {
088        return UserVisitCommandFactory.getInstance();
089    }
090    
091    @Override
092    public boolean hasBeenModified() {
093        return _value.hasBeenModified();
094    }
095    
096    @Override
097    public int hashCode() {
098        return _pk.hashCode();
099    }
100    
101    @Override
102    @Nonnull
103    public String toString() {
104        return _pk.toString();
105    }
106    
107    @Override
108    public boolean equals(Object other) {
109        if(this == other)
110            return true;
111        
112        if(other instanceof UserVisitCommand that) {
113            UserVisitCommandValue thatValue = that.getUserVisitCommandValue();
114            return _value.equals(thatValue);
115        } else {
116            return false;
117        }
118    }
119    
120    @Override
121    public void store()
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().store(this);
124    }
125    
126    @Override
127    public void remove()
128            throws PersistenceDatabaseException {
129        getBaseFactoryInstance().remove(this);
130    }
131    
132    @Nonnull
133    public UserVisitCommandValue getUserVisitCommandValue() {
134        return _value;
135    }
136    
137    public void setUserVisitCommandValue(@Nonnull UserVisitCommandValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    @Nonnull
145    public UserVisitCommandPK getPrimaryKey() {
146        return _pk;
147    }
148    
149    @Nonnull
150    public UserVisitPK getUserVisitPK() {
151        return _value.getUserVisitPK();
152    }
153    
154    @Nonnull
155    public UserVisit getUserVisit(EntityPermission entityPermission) {
156        return UserVisitFactory.getInstance().getEntityFromPK(entityPermission, getUserVisitPK());
157    }
158    
159    @Nonnull
160    public UserVisit getUserVisit() {
161        return getUserVisit(EntityPermission.READ_ONLY);
162    }
163    
164    @Nonnull
165    public UserVisit getUserVisitForUpdate() {
166        return getUserVisit(EntityPermission.READ_WRITE);
167    }
168    
169    public void setUserVisitPK(@Nonnull UserVisitPK userVisitPK)
170            throws PersistenceNotNullException, PersistenceReadOnlyException {
171        checkReadWrite();
172        _value.setUserVisitPK(userVisitPK);
173    }
174    
175    public void setUserVisit(@Nonnull UserVisit entity) {
176        setUserVisitPK(entity == null ? null : entity.getPrimaryKey());
177    }
178    
179    public boolean getUserVisitPKHasBeenModified() {
180        return _value.getUserVisitPKHasBeenModified();
181    }
182    
183    @Nonnull
184    public Integer getUserVisitCommandSequence() {
185        return _value.getUserVisitCommandSequence();
186    }
187    
188    public void setUserVisitCommandSequence(@Nonnull Integer userVisitCommandSequence)
189            throws PersistenceNotNullException, PersistenceReadOnlyException {
190        checkReadWrite();
191        _value.setUserVisitCommandSequence(userVisitCommandSequence);
192    }
193    
194    public boolean getUserVisitCommandSequenceHasBeenModified() {
195        return _value.getUserVisitCommandSequenceHasBeenModified();
196    }
197    
198    @Nullable
199    public PartyPK getPartyPK() {
200        return _value.getPartyPK();
201    }
202    
203    @Nullable
204    public Party getParty(EntityPermission entityPermission) {
205        PartyPK pk = getPartyPK();
206        Party entity = pk == null? null: PartyFactory.getInstance().getEntityFromPK(entityPermission, pk);
207        
208        return entity;
209    }
210    
211    @Nullable
212    public Party getParty() {
213        return getParty(EntityPermission.READ_ONLY);
214    }
215    
216    @Nullable
217    public Party getPartyForUpdate() {
218        return getParty(EntityPermission.READ_WRITE);
219    }
220    
221    public void setPartyPK(@Nullable PartyPK partyPK)
222            throws PersistenceNotNullException, PersistenceReadOnlyException {
223        checkReadWrite();
224        _value.setPartyPK(partyPK);
225    }
226    
227    public void setParty(@Nullable Party entity) {
228        setPartyPK(entity == null ? null : entity.getPrimaryKey());
229    }
230    
231    public boolean getPartyPKHasBeenModified() {
232        return _value.getPartyPKHasBeenModified();
233    }
234    
235    @Nonnull
236    public CommandPK getCommandPK() {
237        return _value.getCommandPK();
238    }
239    
240    @Nonnull
241    public Command getCommand(EntityPermission entityPermission) {
242        return CommandFactory.getInstance().getEntityFromPK(entityPermission, getCommandPK());
243    }
244    
245    @Nonnull
246    public Command getCommand() {
247        return getCommand(EntityPermission.READ_ONLY);
248    }
249    
250    @Nonnull
251    public Command getCommandForUpdate() {
252        return getCommand(EntityPermission.READ_WRITE);
253    }
254    
255    public void setCommandPK(@Nonnull CommandPK commandPK)
256            throws PersistenceNotNullException, PersistenceReadOnlyException {
257        checkReadWrite();
258        _value.setCommandPK(commandPK);
259    }
260    
261    public void setCommand(@Nonnull Command entity) {
262        setCommandPK(entity == null ? null : entity.getPrimaryKey());
263    }
264    
265    public boolean getCommandPKHasBeenModified() {
266        return _value.getCommandPKHasBeenModified();
267    }
268    
269    @Nonnull
270    public Long getStartTime() {
271        return _value.getStartTime();
272    }
273    
274    public void setStartTime(@Nonnull Long startTime)
275            throws PersistenceNotNullException, PersistenceReadOnlyException {
276        checkReadWrite();
277        _value.setStartTime(startTime);
278    }
279    
280    public boolean getStartTimeHasBeenModified() {
281        return _value.getStartTimeHasBeenModified();
282    }
283    
284    @Nonnull
285    public Long getEndTime() {
286        return _value.getEndTime();
287    }
288    
289    public void setEndTime(@Nonnull Long endTime)
290            throws PersistenceNotNullException, PersistenceReadOnlyException {
291        checkReadWrite();
292        _value.setEndTime(endTime);
293    }
294    
295    public boolean getEndTimeHasBeenModified() {
296        return _value.getEndTimeHasBeenModified();
297    }
298    
299    @Nullable
300    public Boolean getHadSecurityErrors() {
301        return _value.getHadSecurityErrors();
302    }
303    
304    public void setHadSecurityErrors(@Nullable Boolean hadSecurityErrors)
305            throws PersistenceNotNullException, PersistenceReadOnlyException {
306        checkReadWrite();
307        _value.setHadSecurityErrors(hadSecurityErrors);
308    }
309    
310    public boolean getHadSecurityErrorsHasBeenModified() {
311        return _value.getHadSecurityErrorsHasBeenModified();
312    }
313    
314    @Nullable
315    public Boolean getHadValidationErrors() {
316        return _value.getHadValidationErrors();
317    }
318    
319    public void setHadValidationErrors(@Nullable Boolean hadValidationErrors)
320            throws PersistenceNotNullException, PersistenceReadOnlyException {
321        checkReadWrite();
322        _value.setHadValidationErrors(hadValidationErrors);
323    }
324    
325    public boolean getHadValidationErrorsHasBeenModified() {
326        return _value.getHadValidationErrorsHasBeenModified();
327    }
328    
329    @Nullable
330    public Boolean getHadExecutionErrors() {
331        return _value.getHadExecutionErrors();
332    }
333    
334    public void setHadExecutionErrors(@Nullable Boolean hadExecutionErrors)
335            throws PersistenceNotNullException, PersistenceReadOnlyException {
336        checkReadWrite();
337        _value.setHadExecutionErrors(hadExecutionErrors);
338    }
339    
340    public boolean getHadExecutionErrorsHasBeenModified() {
341        return _value.getHadExecutionErrorsHasBeenModified();
342    }
343    
344}