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 * 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) {
108            WorkflowStepDetail that = (WorkflowStepDetail)other;
109            
110            WorkflowStepDetailValue thatValue = that.getWorkflowStepDetailValue();
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 WorkflowStepDetailValue getWorkflowStepDetailValue() {
136        return _value;
137    }
138    
139    public void setWorkflowStepDetailValue(WorkflowStepDetailValue value)
140            throws PersistenceReadOnlyException {
141        checkReadWrite();
142        _value = value;
143    }
144    
145    @Override
146    public WorkflowStepDetailPK getPrimaryKey() {
147        return _pk;
148    }
149    
150    public WorkflowStepPK getWorkflowStepPK() {
151        return _value.getWorkflowStepPK();
152    }
153    
154    public WorkflowStep getWorkflowStep(Session session, EntityPermission entityPermission) {
155        return WorkflowStepFactory.getInstance().getEntityFromPK(session, entityPermission, getWorkflowStepPK());
156    }
157    
158    public WorkflowStep getWorkflowStep(EntityPermission entityPermission) {
159        return getWorkflowStep(ThreadSession.currentSession(), entityPermission);
160    }
161    
162    public WorkflowStep getWorkflowStep(Session session) {
163        return getWorkflowStep(session, EntityPermission.READ_ONLY);
164    }
165    
166    public WorkflowStep getWorkflowStep() {
167        return getWorkflowStep(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
168    }
169    
170    public WorkflowStep getWorkflowStepForUpdate(Session session) {
171        return getWorkflowStep(session, EntityPermission.READ_WRITE);
172    }
173    
174    public WorkflowStep getWorkflowStepForUpdate() {
175        return getWorkflowStep(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
176    }
177    
178    public void setWorkflowStepPK(WorkflowStepPK workflowStepPK)
179            throws PersistenceNotNullException, PersistenceReadOnlyException {
180        checkReadWrite();
181        _value.setWorkflowStepPK(workflowStepPK);
182    }
183    
184    public void setWorkflowStep(WorkflowStep entity) {
185        setWorkflowStepPK(entity == null? null: entity.getPrimaryKey());
186    }
187    
188    public boolean getWorkflowStepPKHasBeenModified() {
189        return _value.getWorkflowStepPKHasBeenModified();
190    }
191    
192    public WorkflowPK getWorkflowPK() {
193        return _value.getWorkflowPK();
194    }
195    
196    public Workflow getWorkflow(Session session, EntityPermission entityPermission) {
197        return WorkflowFactory.getInstance().getEntityFromPK(session, entityPermission, getWorkflowPK());
198    }
199    
200    public Workflow getWorkflow(EntityPermission entityPermission) {
201        return getWorkflow(ThreadSession.currentSession(), entityPermission);
202    }
203    
204    public Workflow getWorkflow(Session session) {
205        return getWorkflow(session, EntityPermission.READ_ONLY);
206    }
207    
208    public Workflow getWorkflow() {
209        return getWorkflow(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
210    }
211    
212    public Workflow getWorkflowForUpdate(Session session) {
213        return getWorkflow(session, EntityPermission.READ_WRITE);
214    }
215    
216    public Workflow getWorkflowForUpdate() {
217        return getWorkflow(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
218    }
219    
220    public void setWorkflowPK(WorkflowPK workflowPK)
221            throws PersistenceNotNullException, PersistenceReadOnlyException {
222        checkReadWrite();
223        _value.setWorkflowPK(workflowPK);
224    }
225    
226    public void setWorkflow(Workflow entity) {
227        setWorkflowPK(entity == null? null: entity.getPrimaryKey());
228    }
229    
230    public boolean getWorkflowPKHasBeenModified() {
231        return _value.getWorkflowPKHasBeenModified();
232    }
233    
234    public String getWorkflowStepName() {
235        return _value.getWorkflowStepName();
236    }
237    
238    public void setWorkflowStepName(String workflowStepName)
239            throws PersistenceNotNullException, PersistenceReadOnlyException {
240        checkReadWrite();
241        _value.setWorkflowStepName(workflowStepName);
242    }
243    
244    public boolean getWorkflowStepNameHasBeenModified() {
245        return _value.getWorkflowStepNameHasBeenModified();
246    }
247    
248    public WorkflowStepTypePK getWorkflowStepTypePK() {
249        return _value.getWorkflowStepTypePK();
250    }
251    
252    public WorkflowStepType getWorkflowStepType(Session session, EntityPermission entityPermission) {
253        return WorkflowStepTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getWorkflowStepTypePK());
254    }
255    
256    public WorkflowStepType getWorkflowStepType(EntityPermission entityPermission) {
257        return getWorkflowStepType(ThreadSession.currentSession(), entityPermission);
258    }
259    
260    public WorkflowStepType getWorkflowStepType(Session session) {
261        return getWorkflowStepType(session, EntityPermission.READ_ONLY);
262    }
263    
264    public WorkflowStepType getWorkflowStepType() {
265        return getWorkflowStepType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
266    }
267    
268    public WorkflowStepType getWorkflowStepTypeForUpdate(Session session) {
269        return getWorkflowStepType(session, EntityPermission.READ_WRITE);
270    }
271    
272    public WorkflowStepType getWorkflowStepTypeForUpdate() {
273        return getWorkflowStepType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
274    }
275    
276    public void setWorkflowStepTypePK(WorkflowStepTypePK workflowStepTypePK)
277            throws PersistenceNotNullException, PersistenceReadOnlyException {
278        checkReadWrite();
279        _value.setWorkflowStepTypePK(workflowStepTypePK);
280    }
281    
282    public void setWorkflowStepType(WorkflowStepType entity) {
283        setWorkflowStepTypePK(entity == null? null: entity.getPrimaryKey());
284    }
285    
286    public boolean getWorkflowStepTypePKHasBeenModified() {
287        return _value.getWorkflowStepTypePKHasBeenModified();
288    }
289    
290    public Boolean getIsDefault() {
291        return _value.getIsDefault();
292    }
293    
294    public void setIsDefault(Boolean isDefault)
295            throws PersistenceNotNullException, PersistenceReadOnlyException {
296        checkReadWrite();
297        _value.setIsDefault(isDefault);
298    }
299    
300    public boolean getIsDefaultHasBeenModified() {
301        return _value.getIsDefaultHasBeenModified();
302    }
303    
304    public Integer getSortOrder() {
305        return _value.getSortOrder();
306    }
307    
308    public void setSortOrder(Integer sortOrder)
309            throws PersistenceNotNullException, PersistenceReadOnlyException {
310        checkReadWrite();
311        _value.setSortOrder(sortOrder);
312    }
313    
314    public boolean getSortOrderHasBeenModified() {
315        return _value.getSortOrderHasBeenModified();
316    }
317    
318    public Long getFromTime() {
319        return _value.getFromTime();
320    }
321    
322    public void setFromTime(Long fromTime)
323            throws PersistenceNotNullException, PersistenceReadOnlyException {
324        checkReadWrite();
325        _value.setFromTime(fromTime);
326    }
327    
328    public boolean getFromTimeHasBeenModified() {
329        return _value.getFromTimeHasBeenModified();
330    }
331    
332    public Long getThruTime() {
333        return _value.getThruTime();
334    }
335    
336    public void setThruTime(Long thruTime)
337            throws PersistenceNotNullException, PersistenceReadOnlyException {
338        checkReadWrite();
339        _value.setThruTime(thruTime);
340    }
341    
342    public boolean getThruTimeHasBeenModified() {
343        return _value.getThruTimeHasBeenModified();
344    }
345    
346}