001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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 * GlAccountSummary.java
021 */
022
023package com.echothree.model.data.accounting.server.entity;
024
025import com.echothree.model.data.accounting.common.pk.GlAccountSummaryPK;
026
027import com.echothree.model.data.accounting.common.pk.GlAccountPK;
028import com.echothree.model.data.party.common.pk.PartyPK;
029import com.echothree.model.data.period.common.pk.PeriodPK;
030
031import com.echothree.model.data.accounting.server.entity.GlAccount;
032import com.echothree.model.data.party.server.entity.Party;
033import com.echothree.model.data.period.server.entity.Period;
034
035import com.echothree.model.data.accounting.server.factory.GlAccountFactory;
036import com.echothree.model.data.party.server.factory.PartyFactory;
037import com.echothree.model.data.period.server.factory.PeriodFactory;
038
039import com.echothree.model.data.accounting.common.pk.GlAccountSummaryPK;
040
041import com.echothree.model.data.accounting.server.value.GlAccountSummaryValue;
042
043import com.echothree.model.data.accounting.server.factory.GlAccountSummaryFactory;
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 GlAccountSummary
062        extends BaseEntity
063        implements Serializable {
064    
065    private GlAccountSummaryPK _pk;
066    private GlAccountSummaryValue _value;
067    
068    /** Creates a new instance of GlAccountSummary */
069    public GlAccountSummary()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of GlAccountSummary */
075    public GlAccountSummary(GlAccountSummaryValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public GlAccountSummaryFactory getBaseFactoryInstance() {
084        return GlAccountSummaryFactory.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 GlAccountSummary that) {
108            GlAccountSummaryValue thatValue = that.getGlAccountSummaryValue();
109            return _value.equals(thatValue);
110        } else {
111            return false;
112        }
113    }
114    
115    @Override
116    public void store(Session session)
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().store(session, this);
119    }
120    
121    @Override
122    public void remove(Session session)
123            throws PersistenceDatabaseException {
124        getBaseFactoryInstance().remove(session, this);
125    }
126    
127    @Override
128    public void remove()
129            throws PersistenceDatabaseException {
130        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
131    }
132    
133    public GlAccountSummaryValue getGlAccountSummaryValue() {
134        return _value;
135    }
136    
137    public void setGlAccountSummaryValue(GlAccountSummaryValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    public GlAccountSummaryPK getPrimaryKey() {
145        return _pk;
146    }
147    
148    public GlAccountPK getGlAccountPK() {
149        return _value.getGlAccountPK();
150    }
151    
152    public GlAccount getGlAccount(Session session, EntityPermission entityPermission) {
153        return GlAccountFactory.getInstance().getEntityFromPK(session, entityPermission, getGlAccountPK());
154    }
155    
156    public GlAccount getGlAccount(EntityPermission entityPermission) {
157        return getGlAccount(ThreadSession.currentSession(), entityPermission);
158    }
159    
160    public GlAccount getGlAccount(Session session) {
161        return getGlAccount(session, EntityPermission.READ_ONLY);
162    }
163    
164    public GlAccount getGlAccount() {
165        return getGlAccount(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
166    }
167    
168    public GlAccount getGlAccountForUpdate(Session session) {
169        return getGlAccount(session, EntityPermission.READ_WRITE);
170    }
171    
172    public GlAccount getGlAccountForUpdate() {
173        return getGlAccount(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
174    }
175    
176    public void setGlAccountPK(GlAccountPK glAccountPK)
177            throws PersistenceNotNullException, PersistenceReadOnlyException {
178        checkReadWrite();
179        _value.setGlAccountPK(glAccountPK);
180    }
181    
182    public void setGlAccount(GlAccount entity) {
183        setGlAccountPK(entity == null? null: entity.getPrimaryKey());
184    }
185    
186    public boolean getGlAccountPKHasBeenModified() {
187        return _value.getGlAccountPKHasBeenModified();
188    }
189    
190    public PartyPK getGroupPartyPK() {
191        return _value.getGroupPartyPK();
192    }
193    
194    public Party getGroupParty(Session session, EntityPermission entityPermission) {
195        return PartyFactory.getInstance().getEntityFromPK(session, entityPermission, getGroupPartyPK());
196    }
197    
198    public Party getGroupParty(EntityPermission entityPermission) {
199        return getGroupParty(ThreadSession.currentSession(), entityPermission);
200    }
201    
202    public Party getGroupParty(Session session) {
203        return getGroupParty(session, EntityPermission.READ_ONLY);
204    }
205    
206    public Party getGroupParty() {
207        return getGroupParty(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
208    }
209    
210    public Party getGroupPartyForUpdate(Session session) {
211        return getGroupParty(session, EntityPermission.READ_WRITE);
212    }
213    
214    public Party getGroupPartyForUpdate() {
215        return getGroupParty(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
216    }
217    
218    public void setGroupPartyPK(PartyPK groupPartyPK)
219            throws PersistenceNotNullException, PersistenceReadOnlyException {
220        checkReadWrite();
221        _value.setGroupPartyPK(groupPartyPK);
222    }
223    
224    public void setGroupParty(Party entity) {
225        setGroupPartyPK(entity == null? null: entity.getPrimaryKey());
226    }
227    
228    public boolean getGroupPartyPKHasBeenModified() {
229        return _value.getGroupPartyPKHasBeenModified();
230    }
231    
232    public PeriodPK getPeriodPK() {
233        return _value.getPeriodPK();
234    }
235    
236    public Period getPeriod(Session session, EntityPermission entityPermission) {
237        return PeriodFactory.getInstance().getEntityFromPK(session, entityPermission, getPeriodPK());
238    }
239    
240    public Period getPeriod(EntityPermission entityPermission) {
241        return getPeriod(ThreadSession.currentSession(), entityPermission);
242    }
243    
244    public Period getPeriod(Session session) {
245        return getPeriod(session, EntityPermission.READ_ONLY);
246    }
247    
248    public Period getPeriod() {
249        return getPeriod(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
250    }
251    
252    public Period getPeriodForUpdate(Session session) {
253        return getPeriod(session, EntityPermission.READ_WRITE);
254    }
255    
256    public Period getPeriodForUpdate() {
257        return getPeriod(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
258    }
259    
260    public void setPeriodPK(PeriodPK periodPK)
261            throws PersistenceNotNullException, PersistenceReadOnlyException {
262        checkReadWrite();
263        _value.setPeriodPK(periodPK);
264    }
265    
266    public void setPeriod(Period entity) {
267        setPeriodPK(entity == null? null: entity.getPrimaryKey());
268    }
269    
270    public boolean getPeriodPKHasBeenModified() {
271        return _value.getPeriodPKHasBeenModified();
272    }
273    
274    public Long getDebitTotal() {
275        return _value.getDebitTotal();
276    }
277    
278    public void setDebitTotal(Long debitTotal)
279            throws PersistenceNotNullException, PersistenceReadOnlyException {
280        checkReadWrite();
281        _value.setDebitTotal(debitTotal);
282    }
283    
284    public boolean getDebitTotalHasBeenModified() {
285        return _value.getDebitTotalHasBeenModified();
286    }
287    
288    public Long getCreditTotal() {
289        return _value.getCreditTotal();
290    }
291    
292    public void setCreditTotal(Long creditTotal)
293            throws PersistenceNotNullException, PersistenceReadOnlyException {
294        checkReadWrite();
295        _value.setCreditTotal(creditTotal);
296    }
297    
298    public boolean getCreditTotalHasBeenModified() {
299        return _value.getCreditTotalHasBeenModified();
300    }
301    
302    public Long getBalance() {
303        return _value.getBalance();
304    }
305    
306    public void setBalance(Long balance)
307            throws PersistenceNotNullException, PersistenceReadOnlyException {
308        checkReadWrite();
309        _value.setBalance(balance);
310    }
311    
312    public boolean getBalanceHasBeenModified() {
313        return _value.getBalanceHasBeenModified();
314    }
315    
316}