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 * 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) {
108            UserKeyDetail that = (UserKeyDetail)other;
109            
110            UserKeyDetailValue thatValue = that.getUserKeyDetailValue();
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 UserKeyDetailValue getUserKeyDetailValue() {
136        return _value;
137    }
138    
139    public void setUserKeyDetailValue(UserKeyDetailValue value)
140            throws PersistenceReadOnlyException {
141        checkReadWrite();
142        _value = value;
143    }
144    
145    @Override
146    public UserKeyDetailPK getPrimaryKey() {
147        return _pk;
148    }
149    
150    public UserKeyPK getUserKeyPK() {
151        return _value.getUserKeyPK();
152    }
153    
154    public UserKey getUserKey(Session session, EntityPermission entityPermission) {
155        return UserKeyFactory.getInstance().getEntityFromPK(session, entityPermission, getUserKeyPK());
156    }
157    
158    public UserKey getUserKey(EntityPermission entityPermission) {
159        return getUserKey(ThreadSession.currentSession(), entityPermission);
160    }
161    
162    public UserKey getUserKey(Session session) {
163        return getUserKey(session, EntityPermission.READ_ONLY);
164    }
165    
166    public UserKey getUserKey() {
167        return getUserKey(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
168    }
169    
170    public UserKey getUserKeyForUpdate(Session session) {
171        return getUserKey(session, EntityPermission.READ_WRITE);
172    }
173    
174    public UserKey getUserKeyForUpdate() {
175        return getUserKey(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
176    }
177    
178    public void setUserKeyPK(UserKeyPK userKeyPK)
179            throws PersistenceNotNullException, PersistenceReadOnlyException {
180        checkReadWrite();
181        _value.setUserKeyPK(userKeyPK);
182    }
183    
184    public void setUserKey(UserKey entity) {
185        setUserKeyPK(entity == null? null: entity.getPrimaryKey());
186    }
187    
188    public boolean getUserKeyPKHasBeenModified() {
189        return _value.getUserKeyPKHasBeenModified();
190    }
191    
192    public String getUserKeyName() {
193        return _value.getUserKeyName();
194    }
195    
196    public void setUserKeyName(String userKeyName)
197            throws PersistenceNotNullException, PersistenceReadOnlyException {
198        checkReadWrite();
199        _value.setUserKeyName(userKeyName);
200    }
201    
202    public boolean getUserKeyNameHasBeenModified() {
203        return _value.getUserKeyNameHasBeenModified();
204    }
205    
206    public PartyPK getPartyPK() {
207        return _value.getPartyPK();
208    }
209    
210    public Party getParty(Session session, EntityPermission entityPermission) {
211        PartyPK pk = getPartyPK();
212        Party entity = pk == null? null: PartyFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
213        
214        return entity;
215    }
216    
217    public Party getParty(EntityPermission entityPermission) {
218        return getParty(ThreadSession.currentSession(), entityPermission);
219    }
220    
221    public Party getParty(Session session) {
222        return getParty(session, EntityPermission.READ_ONLY);
223    }
224    
225    public Party getParty() {
226        return getParty(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
227    }
228    
229    public Party getPartyForUpdate(Session session) {
230        return getParty(session, EntityPermission.READ_WRITE);
231    }
232    
233    public Party getPartyForUpdate() {
234        return getParty(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
235    }
236    
237    public void setPartyPK(PartyPK partyPK)
238            throws PersistenceNotNullException, PersistenceReadOnlyException {
239        checkReadWrite();
240        _value.setPartyPK(partyPK);
241    }
242    
243    public void setParty(Party entity) {
244        setPartyPK(entity == null? null: entity.getPrimaryKey());
245    }
246    
247    public boolean getPartyPKHasBeenModified() {
248        return _value.getPartyPKHasBeenModified();
249    }
250    
251    public PartyRelationshipPK getPartyRelationshipPK() {
252        return _value.getPartyRelationshipPK();
253    }
254    
255    public PartyRelationship getPartyRelationship(Session session, EntityPermission entityPermission) {
256        PartyRelationshipPK pk = getPartyRelationshipPK();
257        PartyRelationship entity = pk == null? null: PartyRelationshipFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
258        
259        return entity;
260    }
261    
262    public PartyRelationship getPartyRelationship(EntityPermission entityPermission) {
263        return getPartyRelationship(ThreadSession.currentSession(), entityPermission);
264    }
265    
266    public PartyRelationship getPartyRelationship(Session session) {
267        return getPartyRelationship(session, EntityPermission.READ_ONLY);
268    }
269    
270    public PartyRelationship getPartyRelationship() {
271        return getPartyRelationship(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
272    }
273    
274    public PartyRelationship getPartyRelationshipForUpdate(Session session) {
275        return getPartyRelationship(session, EntityPermission.READ_WRITE);
276    }
277    
278    public PartyRelationship getPartyRelationshipForUpdate() {
279        return getPartyRelationship(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
280    }
281    
282    public void setPartyRelationshipPK(PartyRelationshipPK partyRelationshipPK)
283            throws PersistenceNotNullException, PersistenceReadOnlyException {
284        checkReadWrite();
285        _value.setPartyRelationshipPK(partyRelationshipPK);
286    }
287    
288    public void setPartyRelationship(PartyRelationship entity) {
289        setPartyRelationshipPK(entity == null? null: entity.getPrimaryKey());
290    }
291    
292    public boolean getPartyRelationshipPKHasBeenModified() {
293        return _value.getPartyRelationshipPKHasBeenModified();
294    }
295    
296    public Long getFromTime() {
297        return _value.getFromTime();
298    }
299    
300    public void setFromTime(Long fromTime)
301            throws PersistenceNotNullException, PersistenceReadOnlyException {
302        checkReadWrite();
303        _value.setFromTime(fromTime);
304    }
305    
306    public boolean getFromTimeHasBeenModified() {
307        return _value.getFromTimeHasBeenModified();
308    }
309    
310    public Long getThruTime() {
311        return _value.getThruTime();
312    }
313    
314    public void setThruTime(Long thruTime)
315            throws PersistenceNotNullException, PersistenceReadOnlyException {
316        checkReadWrite();
317        _value.setThruTime(thruTime);
318    }
319    
320    public boolean getThruTimeHasBeenModified() {
321        return _value.getThruTimeHasBeenModified();
322    }
323    
324}