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 * Icon.java
021 */
022
023package com.echothree.model.data.icon.server.entity;
024
025import com.echothree.model.data.icon.common.pk.IconPK;
026
027import com.echothree.model.data.icon.common.pk.IconDetailPK;
028
029import com.echothree.model.data.icon.server.entity.IconDetail;
030
031import com.echothree.model.data.icon.server.factory.IconDetailFactory;
032
033import com.echothree.model.data.icon.common.pk.IconPK;
034
035import com.echothree.model.data.icon.server.value.IconValue;
036
037import com.echothree.model.data.icon.server.factory.IconFactory;
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
055import javax.annotation.Nonnull;
056import javax.annotation.Nullable;
057
058public class Icon
059        extends BaseEntity
060        implements Serializable {
061    
062    private IconPK _pk;
063    private IconValue _value;
064    
065    /** Creates a new instance of Icon */
066    public Icon()
067            throws PersistenceException {
068        super();
069    }
070    
071    /** Creates a new instance of Icon */
072    public Icon(IconValue value, EntityPermission entityPermission) {
073        super(entityPermission);
074        
075        _value = value;
076        _pk = value.getPrimaryKey();
077    }
078    
079    @Override
080    @Nonnull
081    public IconFactory getBaseFactoryInstance() {
082        return IconFactory.getInstance();
083    }
084    
085    @Override
086    public boolean hasBeenModified() {
087        return _value.hasBeenModified();
088    }
089    
090    @Override
091    public int hashCode() {
092        return _pk.hashCode();
093    }
094    
095    @Override
096    @Nonnull
097    public String toString() {
098        return _pk.toString();
099    }
100    
101    @Override
102    public boolean equals(Object other) {
103        if(this == other)
104            return true;
105        
106        if(other instanceof Icon that) {
107            IconValue thatValue = that.getIconValue();
108            return _value.equals(thatValue);
109        } else {
110            return false;
111        }
112    }
113    
114    @Override
115    public void store()
116            throws PersistenceDatabaseException {
117        getBaseFactoryInstance().store(this);
118    }
119    
120    @Override
121    public void remove()
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().remove(this);
124    }
125    
126    @Nonnull
127    public IconValue getIconValue() {
128        return _value;
129    }
130    
131    public void setIconValue(@Nonnull IconValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    @Nonnull
139    public IconPK getPrimaryKey() {
140        return _pk;
141    }
142    
143    @Nullable
144    public IconDetailPK getActiveDetailPK() {
145        return _value.getActiveDetailPK();
146    }
147    
148    @Nullable
149    public IconDetail getActiveDetail(EntityPermission entityPermission) {
150        IconDetailPK pk = getActiveDetailPK();
151        IconDetail entity = pk == null? null: IconDetailFactory.getInstance().getEntityFromPK(entityPermission, pk);
152        
153        return entity;
154    }
155    
156    @Nullable
157    public IconDetail getActiveDetail() {
158        return getActiveDetail(EntityPermission.READ_ONLY);
159    }
160    
161    @Nullable
162    public IconDetail getActiveDetailForUpdate() {
163        return getActiveDetail(EntityPermission.READ_WRITE);
164    }
165    
166    public void setActiveDetailPK(@Nullable IconDetailPK activeDetailPK)
167            throws PersistenceNotNullException, PersistenceReadOnlyException {
168        checkReadWrite();
169        _value.setActiveDetailPK(activeDetailPK);
170    }
171    
172    public void setActiveDetail(@Nullable IconDetail entity) {
173        setActiveDetailPK(entity == null ? null : entity.getPrimaryKey());
174    }
175    
176    public boolean getActiveDetailPKHasBeenModified() {
177        return _value.getActiveDetailPKHasBeenModified();
178    }
179    
180    @Nullable
181    public IconDetailPK getLastDetailPK() {
182        return _value.getLastDetailPK();
183    }
184    
185    @Nullable
186    public IconDetail getLastDetail(EntityPermission entityPermission) {
187        IconDetailPK pk = getLastDetailPK();
188        IconDetail entity = pk == null? null: IconDetailFactory.getInstance().getEntityFromPK(entityPermission, pk);
189        
190        return entity;
191    }
192    
193    @Nullable
194    public IconDetail getLastDetail() {
195        return getLastDetail(EntityPermission.READ_ONLY);
196    }
197    
198    @Nullable
199    public IconDetail getLastDetailForUpdate() {
200        return getLastDetail(EntityPermission.READ_WRITE);
201    }
202    
203    public void setLastDetailPK(@Nullable IconDetailPK lastDetailPK)
204            throws PersistenceNotNullException, PersistenceReadOnlyException {
205        checkReadWrite();
206        _value.setLastDetailPK(lastDetailPK);
207    }
208    
209    public void setLastDetail(@Nullable IconDetail entity) {
210        setLastDetailPK(entity == null ? null : entity.getPrimaryKey());
211    }
212    
213    public boolean getLastDetailPKHasBeenModified() {
214        return _value.getLastDetailPKHasBeenModified();
215    }
216    
217}