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 * WorkflowEntityStatus.java
021 */
022
023package com.echothree.model.data.workflow.server.entity;
024
025import com.echothree.model.data.workflow.common.pk.WorkflowEntityStatusPK;
026
027import com.echothree.model.data.core.common.pk.EntityInstancePK;
028import com.echothree.model.data.workflow.common.pk.WorkflowStepPK;
029import com.echothree.model.data.workeffort.common.pk.WorkEffortScopePK;
030
031import com.echothree.model.data.core.server.entity.EntityInstance;
032import com.echothree.model.data.workflow.server.entity.WorkflowStep;
033import com.echothree.model.data.workeffort.server.entity.WorkEffortScope;
034
035import com.echothree.model.data.core.server.factory.EntityInstanceFactory;
036import com.echothree.model.data.workflow.server.factory.WorkflowStepFactory;
037import com.echothree.model.data.workeffort.server.factory.WorkEffortScopeFactory;
038
039import com.echothree.model.data.workflow.common.pk.WorkflowEntityStatusPK;
040
041import com.echothree.model.data.workflow.server.value.WorkflowEntityStatusValue;
042
043import com.echothree.model.data.workflow.server.factory.WorkflowEntityStatusFactory;
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
061import javax.annotation.Nonnull;
062import javax.annotation.Nullable;
063
064public class WorkflowEntityStatus
065        extends BaseEntity
066        implements Serializable {
067    
068    private WorkflowEntityStatusPK _pk;
069    private WorkflowEntityStatusValue _value;
070    
071    /** Creates a new instance of WorkflowEntityStatus */
072    public WorkflowEntityStatus()
073            throws PersistenceException {
074        super();
075    }
076    
077    /** Creates a new instance of WorkflowEntityStatus */
078    public WorkflowEntityStatus(WorkflowEntityStatusValue value, EntityPermission entityPermission) {
079        super(entityPermission);
080        
081        _value = value;
082        _pk = value.getPrimaryKey();
083    }
084    
085    @Override
086    @Nonnull
087    public WorkflowEntityStatusFactory getBaseFactoryInstance() {
088        return WorkflowEntityStatusFactory.getInstance();
089    }
090    
091    @Override
092    public boolean hasBeenModified() {
093        return _value.hasBeenModified();
094    }
095    
096    @Override
097    public int hashCode() {
098        return _pk.hashCode();
099    }
100    
101    @Override
102    @Nonnull
103    public String toString() {
104        return _pk.toString();
105    }
106    
107    @Override
108    public boolean equals(Object other) {
109        if(this == other)
110            return true;
111        
112        if(other instanceof WorkflowEntityStatus that) {
113            WorkflowEntityStatusValue thatValue = that.getWorkflowEntityStatusValue();
114            return _value.equals(thatValue);
115        } else {
116            return false;
117        }
118    }
119    
120    @Override
121    public void store()
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().store(this);
124    }
125    
126    @Override
127    public void remove()
128            throws PersistenceDatabaseException {
129        getBaseFactoryInstance().remove(this);
130    }
131    
132    @Nonnull
133    public WorkflowEntityStatusValue getWorkflowEntityStatusValue() {
134        return _value;
135    }
136    
137    public void setWorkflowEntityStatusValue(@Nonnull WorkflowEntityStatusValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    @Nonnull
145    public WorkflowEntityStatusPK getPrimaryKey() {
146        return _pk;
147    }
148    
149    @Nonnull
150    public EntityInstancePK getEntityInstancePK() {
151        return _value.getEntityInstancePK();
152    }
153    
154    @Nonnull
155    public EntityInstance getEntityInstance(EntityPermission entityPermission) {
156        return EntityInstanceFactory.getInstance().getEntityFromPK(entityPermission, getEntityInstancePK());
157    }
158    
159    @Nonnull
160    public EntityInstance getEntityInstance() {
161        return getEntityInstance(EntityPermission.READ_ONLY);
162    }
163    
164    @Nonnull
165    public EntityInstance getEntityInstanceForUpdate() {
166        return getEntityInstance(EntityPermission.READ_WRITE);
167    }
168    
169    public void setEntityInstancePK(@Nonnull EntityInstancePK entityInstancePK)
170            throws PersistenceNotNullException, PersistenceReadOnlyException {
171        checkReadWrite();
172        _value.setEntityInstancePK(entityInstancePK);
173    }
174    
175    public void setEntityInstance(@Nonnull EntityInstance entity) {
176        setEntityInstancePK(entity == null ? null : entity.getPrimaryKey());
177    }
178    
179    public boolean getEntityInstancePKHasBeenModified() {
180        return _value.getEntityInstancePKHasBeenModified();
181    }
182    
183    @Nonnull
184    public WorkflowStepPK getWorkflowStepPK() {
185        return _value.getWorkflowStepPK();
186    }
187    
188    @Nonnull
189    public WorkflowStep getWorkflowStep(EntityPermission entityPermission) {
190        return WorkflowStepFactory.getInstance().getEntityFromPK(entityPermission, getWorkflowStepPK());
191    }
192    
193    @Nonnull
194    public WorkflowStep getWorkflowStep() {
195        return getWorkflowStep(EntityPermission.READ_ONLY);
196    }
197    
198    @Nonnull
199    public WorkflowStep getWorkflowStepForUpdate() {
200        return getWorkflowStep(EntityPermission.READ_WRITE);
201    }
202    
203    public void setWorkflowStepPK(@Nonnull WorkflowStepPK workflowStepPK)
204            throws PersistenceNotNullException, PersistenceReadOnlyException {
205        checkReadWrite();
206        _value.setWorkflowStepPK(workflowStepPK);
207    }
208    
209    public void setWorkflowStep(@Nonnull WorkflowStep entity) {
210        setWorkflowStepPK(entity == null ? null : entity.getPrimaryKey());
211    }
212    
213    public boolean getWorkflowStepPKHasBeenModified() {
214        return _value.getWorkflowStepPKHasBeenModified();
215    }
216    
217    @Nullable
218    public WorkEffortScopePK getWorkEffortScopePK() {
219        return _value.getWorkEffortScopePK();
220    }
221    
222    @Nullable
223    public WorkEffortScope getWorkEffortScope(EntityPermission entityPermission) {
224        WorkEffortScopePK pk = getWorkEffortScopePK();
225        WorkEffortScope entity = pk == null? null: WorkEffortScopeFactory.getInstance().getEntityFromPK(entityPermission, pk);
226        
227        return entity;
228    }
229    
230    @Nullable
231    public WorkEffortScope getWorkEffortScope() {
232        return getWorkEffortScope(EntityPermission.READ_ONLY);
233    }
234    
235    @Nullable
236    public WorkEffortScope getWorkEffortScopeForUpdate() {
237        return getWorkEffortScope(EntityPermission.READ_WRITE);
238    }
239    
240    public void setWorkEffortScopePK(@Nullable WorkEffortScopePK workEffortScopePK)
241            throws PersistenceNotNullException, PersistenceReadOnlyException {
242        checkReadWrite();
243        _value.setWorkEffortScopePK(workEffortScopePK);
244    }
245    
246    public void setWorkEffortScope(@Nullable WorkEffortScope entity) {
247        setWorkEffortScopePK(entity == null ? null : entity.getPrimaryKey());
248    }
249    
250    public boolean getWorkEffortScopePKHasBeenModified() {
251        return _value.getWorkEffortScopePKHasBeenModified();
252    }
253    
254    @Nonnull
255    public Long getFromTime() {
256        return _value.getFromTime();
257    }
258    
259    public void setFromTime(@Nonnull Long fromTime)
260            throws PersistenceNotNullException, PersistenceReadOnlyException {
261        checkReadWrite();
262        _value.setFromTime(fromTime);
263    }
264    
265    public boolean getFromTimeHasBeenModified() {
266        return _value.getFromTimeHasBeenModified();
267    }
268    
269    @Nonnull
270    public Long getThruTime() {
271        return _value.getThruTime();
272    }
273    
274    public void setThruTime(@Nonnull Long thruTime)
275            throws PersistenceNotNullException, PersistenceReadOnlyException {
276        checkReadWrite();
277        _value.setThruTime(thruTime);
278    }
279    
280    public boolean getThruTimeHasBeenModified() {
281        return _value.getThruTimeHasBeenModified();
282    }
283    
284}