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 * UserKeyDetail.java
021 */
022
023package com.echothree.model.data.user.server.entity;
024
025import com.echothree.model.data.user.common.pk.UserKeyDetailPK;
026
027import com.echothree.model.data.user.common.pk.UserKeyPK;
028import com.echothree.model.data.party.common.pk.PartyPK;
029import com.echothree.model.data.party.common.pk.PartyRelationshipPK;
030
031import com.echothree.model.data.user.server.entity.UserKey;
032import com.echothree.model.data.party.server.entity.Party;
033import com.echothree.model.data.party.server.entity.PartyRelationship;
034
035import com.echothree.model.data.user.server.factory.UserKeyFactory;
036import com.echothree.model.data.party.server.factory.PartyFactory;
037import com.echothree.model.data.party.server.factory.PartyRelationshipFactory;
038
039import com.echothree.model.data.user.common.pk.UserKeyDetailPK;
040
041import com.echothree.model.data.user.server.value.UserKeyDetailValue;
042
043import com.echothree.model.data.user.server.factory.UserKeyDetailFactory;
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 UserKeyDetail
062        extends BaseEntity
063        implements Serializable {
064    
065    private UserKeyDetailPK _pk;
066    private UserKeyDetailValue _value;
067    
068    /** Creates a new instance of UserKeyDetail */
069    public UserKeyDetail()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of UserKeyDetail */
075    public UserKeyDetail(UserKeyDetailValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public UserKeyDetailFactory getBaseFactoryInstance() {
084        return UserKeyDetailFactory.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 UserKeyDetail that) {
108            UserKeyDetailValue thatValue = that.getUserKeyDetailValue();
109            return _value.equals(thatValue);
110        } else {
111            return false;
112        }
113    }
114    
115    @Override
116    public void store()
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().store(this);
119    }
120    
121    @Override
122    public void remove()
123            throws PersistenceDatabaseException {
124        getBaseFactoryInstance().remove(this);
125    }
126    
127    public UserKeyDetailValue getUserKeyDetailValue() {
128        return _value;
129    }
130    
131    public void setUserKeyDetailValue(UserKeyDetailValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    public UserKeyDetailPK getPrimaryKey() {
139        return _pk;
140    }
141    
142    public UserKeyPK getUserKeyPK() {
143        return _value.getUserKeyPK();
144    }
145    
146    public UserKey getUserKey(EntityPermission entityPermission) {
147        return UserKeyFactory.getInstance().getEntityFromPK(entityPermission, getUserKeyPK());
148    }
149    
150    public UserKey getUserKey() {
151        return getUserKey(EntityPermission.READ_ONLY);
152    }
153    
154    public UserKey getUserKeyForUpdate() {
155        return getUserKey(EntityPermission.READ_WRITE);
156    }
157    
158    public void setUserKeyPK(UserKeyPK userKeyPK)
159            throws PersistenceNotNullException, PersistenceReadOnlyException {
160        checkReadWrite();
161        _value.setUserKeyPK(userKeyPK);
162    }
163    
164    public void setUserKey(UserKey entity) {
165        setUserKeyPK(entity == null? null: entity.getPrimaryKey());
166    }
167    
168    public boolean getUserKeyPKHasBeenModified() {
169        return _value.getUserKeyPKHasBeenModified();
170    }
171    
172    public String getUserKeyName() {
173        return _value.getUserKeyName();
174    }
175    
176    public void setUserKeyName(String userKeyName)
177            throws PersistenceNotNullException, PersistenceReadOnlyException {
178        checkReadWrite();
179        _value.setUserKeyName(userKeyName);
180    }
181    
182    public boolean getUserKeyNameHasBeenModified() {
183        return _value.getUserKeyNameHasBeenModified();
184    }
185    
186    public PartyPK getPartyPK() {
187        return _value.getPartyPK();
188    }
189    
190    public Party getParty(EntityPermission entityPermission) {
191        PartyPK pk = getPartyPK();
192        Party entity = pk == null? null: PartyFactory.getInstance().getEntityFromPK(entityPermission, pk);
193        
194        return entity;
195    }
196    
197    public Party getParty() {
198        return getParty(EntityPermission.READ_ONLY);
199    }
200    
201    public Party getPartyForUpdate() {
202        return getParty(EntityPermission.READ_WRITE);
203    }
204    
205    public void setPartyPK(PartyPK partyPK)
206            throws PersistenceNotNullException, PersistenceReadOnlyException {
207        checkReadWrite();
208        _value.setPartyPK(partyPK);
209    }
210    
211    public void setParty(Party entity) {
212        setPartyPK(entity == null? null: entity.getPrimaryKey());
213    }
214    
215    public boolean getPartyPKHasBeenModified() {
216        return _value.getPartyPKHasBeenModified();
217    }
218    
219    public PartyRelationshipPK getPartyRelationshipPK() {
220        return _value.getPartyRelationshipPK();
221    }
222    
223    public PartyRelationship getPartyRelationship(EntityPermission entityPermission) {
224        PartyRelationshipPK pk = getPartyRelationshipPK();
225        PartyRelationship entity = pk == null? null: PartyRelationshipFactory.getInstance().getEntityFromPK(entityPermission, pk);
226        
227        return entity;
228    }
229    
230    public PartyRelationship getPartyRelationship() {
231        return getPartyRelationship(EntityPermission.READ_ONLY);
232    }
233    
234    public PartyRelationship getPartyRelationshipForUpdate() {
235        return getPartyRelationship(EntityPermission.READ_WRITE);
236    }
237    
238    public void setPartyRelationshipPK(PartyRelationshipPK partyRelationshipPK)
239            throws PersistenceNotNullException, PersistenceReadOnlyException {
240        checkReadWrite();
241        _value.setPartyRelationshipPK(partyRelationshipPK);
242    }
243    
244    public void setPartyRelationship(PartyRelationship entity) {
245        setPartyRelationshipPK(entity == null? null: entity.getPrimaryKey());
246    }
247    
248    public boolean getPartyRelationshipPKHasBeenModified() {
249        return _value.getPartyRelationshipPKHasBeenModified();
250    }
251    
252    public Long getFromTime() {
253        return _value.getFromTime();
254    }
255    
256    public void setFromTime(Long fromTime)
257            throws PersistenceNotNullException, PersistenceReadOnlyException {
258        checkReadWrite();
259        _value.setFromTime(fromTime);
260    }
261    
262    public boolean getFromTimeHasBeenModified() {
263        return _value.getFromTimeHasBeenModified();
264    }
265    
266    public Long getThruTime() {
267        return _value.getThruTime();
268    }
269    
270    public void setThruTime(Long thruTime)
271            throws PersistenceNotNullException, PersistenceReadOnlyException {
272        checkReadWrite();
273        _value.setThruTime(thruTime);
274    }
275    
276    public boolean getThruTimeHasBeenModified() {
277        return _value.getThruTimeHasBeenModified();
278    }
279    
280}