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 * WorkflowStepDetail.java
021 */
022
023package com.echothree.model.data.workflow.server.entity;
024
025import com.echothree.model.data.workflow.common.pk.WorkflowStepDetailPK;
026
027import com.echothree.model.data.workflow.common.pk.WorkflowStepPK;
028import com.echothree.model.data.workflow.common.pk.WorkflowPK;
029import com.echothree.model.data.workflow.common.pk.WorkflowStepTypePK;
030
031import com.echothree.model.data.workflow.server.entity.WorkflowStep;
032import com.echothree.model.data.workflow.server.entity.Workflow;
033import com.echothree.model.data.workflow.server.entity.WorkflowStepType;
034
035import com.echothree.model.data.workflow.server.factory.WorkflowStepFactory;
036import com.echothree.model.data.workflow.server.factory.WorkflowFactory;
037import com.echothree.model.data.workflow.server.factory.WorkflowStepTypeFactory;
038
039import com.echothree.model.data.workflow.common.pk.WorkflowStepDetailPK;
040
041import com.echothree.model.data.workflow.server.value.WorkflowStepDetailValue;
042
043import com.echothree.model.data.workflow.server.factory.WorkflowStepDetailFactory;
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 WorkflowStepDetail
062        extends BaseEntity
063        implements Serializable {
064    
065    private WorkflowStepDetailPK _pk;
066    private WorkflowStepDetailValue _value;
067    
068    /** Creates a new instance of WorkflowStepDetail */
069    public WorkflowStepDetail()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of WorkflowStepDetail */
075    public WorkflowStepDetail(WorkflowStepDetailValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public WorkflowStepDetailFactory getBaseFactoryInstance() {
084        return WorkflowStepDetailFactory.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 WorkflowStepDetail that) {
108            WorkflowStepDetailValue thatValue = that.getWorkflowStepDetailValue();
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 WorkflowStepDetailValue getWorkflowStepDetailValue() {
134        return _value;
135    }
136    
137    public void setWorkflowStepDetailValue(WorkflowStepDetailValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    public WorkflowStepDetailPK getPrimaryKey() {
145        return _pk;
146    }
147    
148    public WorkflowStepPK getWorkflowStepPK() {
149        return _value.getWorkflowStepPK();
150    }
151    
152    public WorkflowStep getWorkflowStep(Session session, EntityPermission entityPermission) {
153        return WorkflowStepFactory.getInstance().getEntityFromPK(session, entityPermission, getWorkflowStepPK());
154    }
155    
156    public WorkflowStep getWorkflowStep(EntityPermission entityPermission) {
157        return getWorkflowStep(ThreadSession.currentSession(), entityPermission);
158    }
159    
160    public WorkflowStep getWorkflowStep(Session session) {
161        return getWorkflowStep(session, EntityPermission.READ_ONLY);
162    }
163    
164    public WorkflowStep getWorkflowStep() {
165        return getWorkflowStep(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
166    }
167    
168    public WorkflowStep getWorkflowStepForUpdate(Session session) {
169        return getWorkflowStep(session, EntityPermission.READ_WRITE);
170    }
171    
172    public WorkflowStep getWorkflowStepForUpdate() {
173        return getWorkflowStep(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
174    }
175    
176    public void setWorkflowStepPK(WorkflowStepPK workflowStepPK)
177            throws PersistenceNotNullException, PersistenceReadOnlyException {
178        checkReadWrite();
179        _value.setWorkflowStepPK(workflowStepPK);
180    }
181    
182    public void setWorkflowStep(WorkflowStep entity) {
183        setWorkflowStepPK(entity == null? null: entity.getPrimaryKey());
184    }
185    
186    public boolean getWorkflowStepPKHasBeenModified() {
187        return _value.getWorkflowStepPKHasBeenModified();
188    }
189    
190    public WorkflowPK getWorkflowPK() {
191        return _value.getWorkflowPK();
192    }
193    
194    public Workflow getWorkflow(Session session, EntityPermission entityPermission) {
195        return WorkflowFactory.getInstance().getEntityFromPK(session, entityPermission, getWorkflowPK());
196    }
197    
198    public Workflow getWorkflow(EntityPermission entityPermission) {
199        return getWorkflow(ThreadSession.currentSession(), entityPermission);
200    }
201    
202    public Workflow getWorkflow(Session session) {
203        return getWorkflow(session, EntityPermission.READ_ONLY);
204    }
205    
206    public Workflow getWorkflow() {
207        return getWorkflow(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
208    }
209    
210    public Workflow getWorkflowForUpdate(Session session) {
211        return getWorkflow(session, EntityPermission.READ_WRITE);
212    }
213    
214    public Workflow getWorkflowForUpdate() {
215        return getWorkflow(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
216    }
217    
218    public void setWorkflowPK(WorkflowPK workflowPK)
219            throws PersistenceNotNullException, PersistenceReadOnlyException {
220        checkReadWrite();
221        _value.setWorkflowPK(workflowPK);
222    }
223    
224    public void setWorkflow(Workflow entity) {
225        setWorkflowPK(entity == null? null: entity.getPrimaryKey());
226    }
227    
228    public boolean getWorkflowPKHasBeenModified() {
229        return _value.getWorkflowPKHasBeenModified();
230    }
231    
232    public String getWorkflowStepName() {
233        return _value.getWorkflowStepName();
234    }
235    
236    public void setWorkflowStepName(String workflowStepName)
237            throws PersistenceNotNullException, PersistenceReadOnlyException {
238        checkReadWrite();
239        _value.setWorkflowStepName(workflowStepName);
240    }
241    
242    public boolean getWorkflowStepNameHasBeenModified() {
243        return _value.getWorkflowStepNameHasBeenModified();
244    }
245    
246    public WorkflowStepTypePK getWorkflowStepTypePK() {
247        return _value.getWorkflowStepTypePK();
248    }
249    
250    public WorkflowStepType getWorkflowStepType(Session session, EntityPermission entityPermission) {
251        return WorkflowStepTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getWorkflowStepTypePK());
252    }
253    
254    public WorkflowStepType getWorkflowStepType(EntityPermission entityPermission) {
255        return getWorkflowStepType(ThreadSession.currentSession(), entityPermission);
256    }
257    
258    public WorkflowStepType getWorkflowStepType(Session session) {
259        return getWorkflowStepType(session, EntityPermission.READ_ONLY);
260    }
261    
262    public WorkflowStepType getWorkflowStepType() {
263        return getWorkflowStepType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
264    }
265    
266    public WorkflowStepType getWorkflowStepTypeForUpdate(Session session) {
267        return getWorkflowStepType(session, EntityPermission.READ_WRITE);
268    }
269    
270    public WorkflowStepType getWorkflowStepTypeForUpdate() {
271        return getWorkflowStepType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
272    }
273    
274    public void setWorkflowStepTypePK(WorkflowStepTypePK workflowStepTypePK)
275            throws PersistenceNotNullException, PersistenceReadOnlyException {
276        checkReadWrite();
277        _value.setWorkflowStepTypePK(workflowStepTypePK);
278    }
279    
280    public void setWorkflowStepType(WorkflowStepType entity) {
281        setWorkflowStepTypePK(entity == null? null: entity.getPrimaryKey());
282    }
283    
284    public boolean getWorkflowStepTypePKHasBeenModified() {
285        return _value.getWorkflowStepTypePKHasBeenModified();
286    }
287    
288    public Boolean getIsDefault() {
289        return _value.getIsDefault();
290    }
291    
292    public void setIsDefault(Boolean isDefault)
293            throws PersistenceNotNullException, PersistenceReadOnlyException {
294        checkReadWrite();
295        _value.setIsDefault(isDefault);
296    }
297    
298    public boolean getIsDefaultHasBeenModified() {
299        return _value.getIsDefaultHasBeenModified();
300    }
301    
302    public Integer getSortOrder() {
303        return _value.getSortOrder();
304    }
305    
306    public void setSortOrder(Integer sortOrder)
307            throws PersistenceNotNullException, PersistenceReadOnlyException {
308        checkReadWrite();
309        _value.setSortOrder(sortOrder);
310    }
311    
312    public boolean getSortOrderHasBeenModified() {
313        return _value.getSortOrderHasBeenModified();
314    }
315    
316    public Long getFromTime() {
317        return _value.getFromTime();
318    }
319    
320    public void setFromTime(Long fromTime)
321            throws PersistenceNotNullException, PersistenceReadOnlyException {
322        checkReadWrite();
323        _value.setFromTime(fromTime);
324    }
325    
326    public boolean getFromTimeHasBeenModified() {
327        return _value.getFromTimeHasBeenModified();
328    }
329    
330    public Long getThruTime() {
331        return _value.getThruTime();
332    }
333    
334    public void setThruTime(Long thruTime)
335            throws PersistenceNotNullException, PersistenceReadOnlyException {
336        checkReadWrite();
337        _value.setThruTime(thruTime);
338    }
339    
340    public boolean getThruTimeHasBeenModified() {
341        return _value.getThruTimeHasBeenModified();
342    }
343    
344}