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 * PeriodDetail.java
021 */
022
023package com.echothree.model.data.period.server.entity;
024
025import com.echothree.model.data.period.common.pk.PeriodDetailPK;
026
027import com.echothree.model.data.period.common.pk.PeriodPK;
028import com.echothree.model.data.period.common.pk.PeriodKindPK;
029import com.echothree.model.data.period.common.pk.PeriodTypePK;
030
031import com.echothree.model.data.period.server.entity.Period;
032import com.echothree.model.data.period.server.entity.PeriodKind;
033import com.echothree.model.data.period.server.entity.PeriodType;
034
035import com.echothree.model.data.period.server.factory.PeriodFactory;
036import com.echothree.model.data.period.server.factory.PeriodKindFactory;
037import com.echothree.model.data.period.server.factory.PeriodTypeFactory;
038
039import com.echothree.model.data.period.common.pk.PeriodDetailPK;
040
041import com.echothree.model.data.period.server.value.PeriodDetailValue;
042
043import com.echothree.model.data.period.server.factory.PeriodDetailFactory;
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 PeriodDetail
062        extends BaseEntity
063        implements Serializable {
064    
065    private PeriodDetailPK _pk;
066    private PeriodDetailValue _value;
067    
068    /** Creates a new instance of PeriodDetail */
069    public PeriodDetail()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of PeriodDetail */
075    public PeriodDetail(PeriodDetailValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public PeriodDetailFactory getBaseFactoryInstance() {
084        return PeriodDetailFactory.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 PeriodDetail) {
108            PeriodDetail that = (PeriodDetail)other;
109            
110            PeriodDetailValue thatValue = that.getPeriodDetailValue();
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 PeriodDetailValue getPeriodDetailValue() {
136        return _value;
137    }
138    
139    public void setPeriodDetailValue(PeriodDetailValue value)
140            throws PersistenceReadOnlyException {
141        checkReadWrite();
142        _value = value;
143    }
144    
145    @Override
146    public PeriodDetailPK getPrimaryKey() {
147        return _pk;
148    }
149    
150    public PeriodPK getPeriodPK() {
151        return _value.getPeriodPK();
152    }
153    
154    public Period getPeriod(Session session, EntityPermission entityPermission) {
155        return PeriodFactory.getInstance().getEntityFromPK(session, entityPermission, getPeriodPK());
156    }
157    
158    public Period getPeriod(EntityPermission entityPermission) {
159        return getPeriod(ThreadSession.currentSession(), entityPermission);
160    }
161    
162    public Period getPeriod(Session session) {
163        return getPeriod(session, EntityPermission.READ_ONLY);
164    }
165    
166    public Period getPeriod() {
167        return getPeriod(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
168    }
169    
170    public Period getPeriodForUpdate(Session session) {
171        return getPeriod(session, EntityPermission.READ_WRITE);
172    }
173    
174    public Period getPeriodForUpdate() {
175        return getPeriod(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
176    }
177    
178    public void setPeriodPK(PeriodPK periodPK)
179            throws PersistenceNotNullException, PersistenceReadOnlyException {
180        checkReadWrite();
181        _value.setPeriodPK(periodPK);
182    }
183    
184    public void setPeriod(Period entity) {
185        setPeriodPK(entity == null? null: entity.getPrimaryKey());
186    }
187    
188    public boolean getPeriodPKHasBeenModified() {
189        return _value.getPeriodPKHasBeenModified();
190    }
191    
192    public PeriodKindPK getPeriodKindPK() {
193        return _value.getPeriodKindPK();
194    }
195    
196    public PeriodKind getPeriodKind(Session session, EntityPermission entityPermission) {
197        return PeriodKindFactory.getInstance().getEntityFromPK(session, entityPermission, getPeriodKindPK());
198    }
199    
200    public PeriodKind getPeriodKind(EntityPermission entityPermission) {
201        return getPeriodKind(ThreadSession.currentSession(), entityPermission);
202    }
203    
204    public PeriodKind getPeriodKind(Session session) {
205        return getPeriodKind(session, EntityPermission.READ_ONLY);
206    }
207    
208    public PeriodKind getPeriodKind() {
209        return getPeriodKind(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
210    }
211    
212    public PeriodKind getPeriodKindForUpdate(Session session) {
213        return getPeriodKind(session, EntityPermission.READ_WRITE);
214    }
215    
216    public PeriodKind getPeriodKindForUpdate() {
217        return getPeriodKind(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
218    }
219    
220    public void setPeriodKindPK(PeriodKindPK periodKindPK)
221            throws PersistenceNotNullException, PersistenceReadOnlyException {
222        checkReadWrite();
223        _value.setPeriodKindPK(periodKindPK);
224    }
225    
226    public void setPeriodKind(PeriodKind entity) {
227        setPeriodKindPK(entity == null? null: entity.getPrimaryKey());
228    }
229    
230    public boolean getPeriodKindPKHasBeenModified() {
231        return _value.getPeriodKindPKHasBeenModified();
232    }
233    
234    public String getPeriodName() {
235        return _value.getPeriodName();
236    }
237    
238    public void setPeriodName(String periodName)
239            throws PersistenceNotNullException, PersistenceReadOnlyException {
240        checkReadWrite();
241        _value.setPeriodName(periodName);
242    }
243    
244    public boolean getPeriodNameHasBeenModified() {
245        return _value.getPeriodNameHasBeenModified();
246    }
247    
248    public PeriodPK getParentPeriodPK() {
249        return _value.getParentPeriodPK();
250    }
251    
252    public Period getParentPeriod(Session session, EntityPermission entityPermission) {
253        PeriodPK pk = getParentPeriodPK();
254        Period entity = pk == null? null: PeriodFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
255        
256        return entity;
257    }
258    
259    public Period getParentPeriod(EntityPermission entityPermission) {
260        return getParentPeriod(ThreadSession.currentSession(), entityPermission);
261    }
262    
263    public Period getParentPeriod(Session session) {
264        return getParentPeriod(session, EntityPermission.READ_ONLY);
265    }
266    
267    public Period getParentPeriod() {
268        return getParentPeriod(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
269    }
270    
271    public Period getParentPeriodForUpdate(Session session) {
272        return getParentPeriod(session, EntityPermission.READ_WRITE);
273    }
274    
275    public Period getParentPeriodForUpdate() {
276        return getParentPeriod(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
277    }
278    
279    public void setParentPeriodPK(PeriodPK parentPeriodPK)
280            throws PersistenceNotNullException, PersistenceReadOnlyException {
281        checkReadWrite();
282        _value.setParentPeriodPK(parentPeriodPK);
283    }
284    
285    public void setParentPeriod(Period entity) {
286        setParentPeriodPK(entity == null? null: entity.getPrimaryKey());
287    }
288    
289    public boolean getParentPeriodPKHasBeenModified() {
290        return _value.getParentPeriodPKHasBeenModified();
291    }
292    
293    public PeriodTypePK getPeriodTypePK() {
294        return _value.getPeriodTypePK();
295    }
296    
297    public PeriodType getPeriodType(Session session, EntityPermission entityPermission) {
298        PeriodTypePK pk = getPeriodTypePK();
299        PeriodType entity = pk == null? null: PeriodTypeFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
300        
301        return entity;
302    }
303    
304    public PeriodType getPeriodType(EntityPermission entityPermission) {
305        return getPeriodType(ThreadSession.currentSession(), entityPermission);
306    }
307    
308    public PeriodType getPeriodType(Session session) {
309        return getPeriodType(session, EntityPermission.READ_ONLY);
310    }
311    
312    public PeriodType getPeriodType() {
313        return getPeriodType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
314    }
315    
316    public PeriodType getPeriodTypeForUpdate(Session session) {
317        return getPeriodType(session, EntityPermission.READ_WRITE);
318    }
319    
320    public PeriodType getPeriodTypeForUpdate() {
321        return getPeriodType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
322    }
323    
324    public void setPeriodTypePK(PeriodTypePK periodTypePK)
325            throws PersistenceNotNullException, PersistenceReadOnlyException {
326        checkReadWrite();
327        _value.setPeriodTypePK(periodTypePK);
328    }
329    
330    public void setPeriodType(PeriodType entity) {
331        setPeriodTypePK(entity == null? null: entity.getPrimaryKey());
332    }
333    
334    public boolean getPeriodTypePKHasBeenModified() {
335        return _value.getPeriodTypePKHasBeenModified();
336    }
337    
338    public Long getStartTime() {
339        return _value.getStartTime();
340    }
341    
342    public void setStartTime(Long startTime)
343            throws PersistenceNotNullException, PersistenceReadOnlyException {
344        checkReadWrite();
345        _value.setStartTime(startTime);
346    }
347    
348    public boolean getStartTimeHasBeenModified() {
349        return _value.getStartTimeHasBeenModified();
350    }
351    
352    public Long getEndTime() {
353        return _value.getEndTime();
354    }
355    
356    public void setEndTime(Long endTime)
357            throws PersistenceNotNullException, PersistenceReadOnlyException {
358        checkReadWrite();
359        _value.setEndTime(endTime);
360    }
361    
362    public boolean getEndTimeHasBeenModified() {
363        return _value.getEndTimeHasBeenModified();
364    }
365    
366    public Long getFromTime() {
367        return _value.getFromTime();
368    }
369    
370    public void setFromTime(Long fromTime)
371            throws PersistenceNotNullException, PersistenceReadOnlyException {
372        checkReadWrite();
373        _value.setFromTime(fromTime);
374    }
375    
376    public boolean getFromTimeHasBeenModified() {
377        return _value.getFromTimeHasBeenModified();
378    }
379    
380    public Long getThruTime() {
381        return _value.getThruTime();
382    }
383    
384    public void setThruTime(Long thruTime)
385            throws PersistenceNotNullException, PersistenceReadOnlyException {
386        checkReadWrite();
387        _value.setThruTime(thruTime);
388    }
389    
390    public boolean getThruTimeHasBeenModified() {
391        return _value.getThruTimeHasBeenModified();
392    }
393    
394}