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 * EntityInstance.java
021 */
022
023package com.echothree.model.data.core.server.entity;
024
025import com.echothree.model.data.core.common.pk.EntityInstancePK;
026
027import com.echothree.model.data.core.common.pk.EntityTypePK;
028
029import com.echothree.model.data.core.server.entity.EntityType;
030
031import com.echothree.model.data.core.server.factory.EntityTypeFactory;
032
033import com.echothree.model.data.core.common.pk.EntityInstancePK;
034
035import com.echothree.model.data.core.server.value.EntityInstanceValue;
036
037import com.echothree.model.data.core.server.factory.EntityInstanceFactory;
038
039import com.echothree.util.common.exception.PersistenceException;
040import com.echothree.util.common.exception.PersistenceDatabaseException;
041import com.echothree.util.common.exception.PersistenceNotNullException;
042import com.echothree.util.common.exception.PersistenceReadOnlyException;
043
044import com.echothree.util.common.persistence.BasePK;
045
046import com.echothree.util.common.persistence.type.ByteArray;
047
048import com.echothree.util.server.persistence.BaseEntity;
049import com.echothree.util.server.persistence.EntityPermission;
050import com.echothree.util.server.persistence.Session;
051import com.echothree.util.server.persistence.ThreadSession;
052
053import java.io.Serializable;
054
055public class EntityInstance
056        extends BaseEntity
057        implements Serializable {
058    
059    private EntityInstancePK _pk;
060    private EntityInstanceValue _value;
061    
062    /** Creates a new instance of EntityInstance */
063    public EntityInstance()
064            throws PersistenceException {
065        super();
066    }
067    
068    /** Creates a new instance of EntityInstance */
069    public EntityInstance(EntityInstanceValue value, EntityPermission entityPermission) {
070        super(entityPermission);
071        
072        _value = value;
073        _pk = value.getPrimaryKey();
074    }
075    
076    @Override
077    public EntityInstanceFactory getBaseFactoryInstance() {
078        return EntityInstanceFactory.getInstance();
079    }
080    
081    @Override
082    public boolean hasBeenModified() {
083        return _value.hasBeenModified();
084    }
085    
086    @Override
087    public int hashCode() {
088        return _pk.hashCode();
089    }
090    
091    @Override
092    public String toString() {
093        return _pk.toString();
094    }
095    
096    @Override
097    public boolean equals(Object other) {
098        if(this == other)
099            return true;
100        
101        if(other instanceof EntityInstance) {
102            EntityInstance that = (EntityInstance)other;
103            
104            EntityInstanceValue thatValue = that.getEntityInstanceValue();
105            return _value.equals(thatValue);
106        } else {
107            return false;
108        }
109    }
110    
111    @Override
112    public void store(Session session)
113            throws PersistenceDatabaseException {
114        getBaseFactoryInstance().store(session, this);
115    }
116    
117    @Override
118    public void remove(Session session)
119            throws PersistenceDatabaseException {
120        getBaseFactoryInstance().remove(session, this);
121    }
122    
123    @Override
124    public void remove()
125            throws PersistenceDatabaseException {
126        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
127    }
128    
129    public EntityInstanceValue getEntityInstanceValue() {
130        return _value;
131    }
132    
133    public void setEntityInstanceValue(EntityInstanceValue value)
134            throws PersistenceReadOnlyException {
135        checkReadWrite();
136        _value = value;
137    }
138    
139    @Override
140    public EntityInstancePK getPrimaryKey() {
141        return _pk;
142    }
143    
144    public EntityTypePK getEntityTypePK() {
145        return _value.getEntityTypePK();
146    }
147    
148    public EntityType getEntityType(Session session, EntityPermission entityPermission) {
149        return EntityTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getEntityTypePK());
150    }
151    
152    public EntityType getEntityType(EntityPermission entityPermission) {
153        return getEntityType(ThreadSession.currentSession(), entityPermission);
154    }
155    
156    public EntityType getEntityType(Session session) {
157        return getEntityType(session, EntityPermission.READ_ONLY);
158    }
159    
160    public EntityType getEntityType() {
161        return getEntityType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
162    }
163    
164    public EntityType getEntityTypeForUpdate(Session session) {
165        return getEntityType(session, EntityPermission.READ_WRITE);
166    }
167    
168    public EntityType getEntityTypeForUpdate() {
169        return getEntityType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
170    }
171    
172    public void setEntityTypePK(EntityTypePK entityTypePK)
173            throws PersistenceNotNullException, PersistenceReadOnlyException {
174        checkReadWrite();
175        _value.setEntityTypePK(entityTypePK);
176    }
177    
178    public void setEntityType(EntityType entity) {
179        setEntityTypePK(entity == null? null: entity.getPrimaryKey());
180    }
181    
182    public boolean getEntityTypePKHasBeenModified() {
183        return _value.getEntityTypePKHasBeenModified();
184    }
185    
186    public Long getEntityUniqueId() {
187        return _value.getEntityUniqueId();
188    }
189    
190    public void setEntityUniqueId(Long entityUniqueId)
191            throws PersistenceNotNullException, PersistenceReadOnlyException {
192        checkReadWrite();
193        _value.setEntityUniqueId(entityUniqueId);
194    }
195    
196    public boolean getEntityUniqueIdHasBeenModified() {
197        return _value.getEntityUniqueIdHasBeenModified();
198    }
199    
200    public String getKey() {
201        return _value.getKey();
202    }
203    
204    public void setKey(String key)
205            throws PersistenceNotNullException, PersistenceReadOnlyException {
206        checkReadWrite();
207        _value.setKey(key);
208    }
209    
210    public boolean getKeyHasBeenModified() {
211        return _value.getKeyHasBeenModified();
212    }
213    
214    public String getGuid() {
215        return _value.getGuid();
216    }
217    
218    public void setGuid(String guid)
219            throws PersistenceNotNullException, PersistenceReadOnlyException {
220        checkReadWrite();
221        _value.setGuid(guid);
222    }
223    
224    public boolean getGuidHasBeenModified() {
225        return _value.getGuidHasBeenModified();
226    }
227    
228    public String getUlid() {
229        return _value.getUlid();
230    }
231    
232    public void setUlid(String ulid)
233            throws PersistenceNotNullException, PersistenceReadOnlyException {
234        checkReadWrite();
235        _value.setUlid(ulid);
236    }
237    
238    public boolean getUlidHasBeenModified() {
239        return _value.getUlidHasBeenModified();
240    }
241    
242}