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
017package com.echothree.control.user.core.server.command;
018
019import com.echothree.control.user.core.common.edit.CoreEditFactory;
020import com.echothree.control.user.core.common.edit.EntityEntityAttributeEdit;
021import com.echothree.control.user.core.common.form.EditEntityEntityAttributeForm;
022import com.echothree.control.user.core.common.result.CoreResultFactory;
023import com.echothree.control.user.core.common.spec.EntityEntityAttributeSpec;
024import com.echothree.model.control.core.common.EntityAttributeTypes;
025import com.echothree.model.control.core.server.logic.EntityAttributeLogic;
026import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.data.core.server.entity.EntityEntityAttribute;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.command.EditMode;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.server.control.BaseEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.persistence.PersistenceUtils;
039import java.util.List;
040import javax.enterprise.context.RequestScoped;
041
042@RequestScoped
043public class EditEntityEntityAttributeCommand
044        extends BaseEditCommand<EntityEntityAttributeSpec, EntityEntityAttributeEdit> {
045
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
048    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), null)
054        ));
055
056        SPEC_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
058                new FieldDefinition("Uuid", FieldType.UUID, false, null, null),
059                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, false, null, null),
060                new FieldDefinition("EntityAttributeUuid", FieldType.UUID, false, null, null)
061        );
062        
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("EntityRefAttribute", FieldType.ENTITY_REF, false, null, null),
065                new FieldDefinition("UuidAttribute", FieldType.UUID, false, null, null)
066        );
067    }
068    
069    /** Creates a new instance of EditEntityEntityAttributeCommand */
070    public EditEntityEntityAttributeCommand() {
071        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
072    }
073    
074    @Override
075    protected BaseResult execute() {
076        var result = CoreResultFactory.getEditEntityEntityAttributeResult();
077        var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, spec);
078
079        if(!hasExecutionErrors()) {
080            var entityAttribute = EntityAttributeLogic.getInstance().getEntityAttribute(this, entityInstance, spec, spec,
081                    EntityAttributeTypes.ENTITY);
082
083            if(!hasExecutionErrors()) {
084                EntityEntityAttribute entityEntityAttribute = null;
085                var basePK = PersistenceUtils.getInstance().getBasePKFromEntityInstance(entityInstance);
086
087                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
088                    entityEntityAttribute = coreControl.getEntityEntityAttribute(entityAttribute, entityInstance);
089
090                    if(entityEntityAttribute != null) {
091                        if(editMode.equals(EditMode.LOCK)) {
092                            result.setEntityEntityAttribute(coreControl.getEntityEntityAttributeTransfer(getUserVisit(), entityEntityAttribute, entityInstance));
093
094                            if(lockEntity(basePK)) {
095                                var edit = CoreEditFactory.getEntityEntityAttributeEdit();
096
097                                result.setEdit(edit);
098                                edit.setEntityRefAttribute(EntityInstanceLogic.getInstance().getEntityRefFromEntityInstance(entityEntityAttribute.getEntityInstanceAttribute()));
099                            } else {
100                                addExecutionError(ExecutionErrors.EntityLockFailed.name());
101                            }
102                        } else { // EditMode.ABANDON
103                            unlockEntity(basePK);
104                            basePK = null;
105                        }
106                    } else {
107                        var entityTypeDetail = entityInstance.getEntityType().getLastDetail();
108
109                        addExecutionError(ExecutionErrors.UnknownEntityEntityAttribute.name(), basePK.getEntityRef(),
110                                entityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName(),
111                                entityTypeDetail.getEntityTypeName(), entityAttribute.getLastDetail().getEntityAttributeName());
112                    }
113                } else if(editMode.equals(EditMode.UPDATE)) {
114                    var entityInstanceAttribute = EntityAttributeLogic.getInstance().getEntityInstanceAttribute(this, edit);
115
116                    if(!hasExecutionErrors()) {
117                        if(coreControl.countEntityAttributeEntityTypesByEntityAttribute(entityAttribute) > 0) {
118                            var allowedEntityType = entityInstanceAttribute.getEntityType();
119
120                            if(!coreControl.entityAttributeEntityTypeExists(entityAttribute, allowedEntityType)) {
121                                var entityAttributeDetail = entityAttribute.getLastDetail();
122                                var entityTypeDetail = entityAttributeDetail.getEntityType().getLastDetail();
123                                var allowedEntityTypeDetail = allowedEntityType.getLastDetail();
124
125                                addExecutionError(ExecutionErrors.UnknownEntityAttributeEntityType.name(),
126                                        entityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName(),
127                                        entityTypeDetail.getEntityTypeName(), entityAttributeDetail.getEntityAttributeName(),
128                                        allowedEntityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName(),
129                                        allowedEntityTypeDetail.getEntityTypeName());
130                            }
131                        }
132
133                        if(!hasExecutionErrors()) {
134                            entityEntityAttribute = coreControl.getEntityEntityAttributeForUpdate(entityAttribute, entityInstance);
135
136                            if(!hasExecutionErrors()) {
137                                if(lockEntityForUpdate(basePK)) {
138                                    try {
139                                        var entityEntityAttributeValue = coreControl.getEntityEntityAttributeValueForUpdate(entityEntityAttribute);
140
141                                        entityEntityAttributeValue.setEntityInstanceAttributePK(entityInstanceAttribute.getPrimaryKey());
142
143                                        coreControl.updateEntityEntityAttributeFromValue(entityEntityAttributeValue, getPartyPK());
144                                    } finally {
145                                        unlockEntity(basePK);
146                                        basePK = null;
147                                    }
148                                } else {
149                                    addExecutionError(ExecutionErrors.EntityLockStale.name());
150                                }
151                            } else {
152                                var entityTypeDetail = entityInstance.getEntityType().getLastDetail();
153
154                                addExecutionError(ExecutionErrors.UnknownEntityEntityAttribute.name(), basePK.getEntityRef(),
155                                        entityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName(),
156                                        entityTypeDetail.getEntityTypeName(), entityAttribute.getLastDetail().getEntityAttributeName());
157                            }
158                        }
159                    }
160                }
161
162                if(basePK != null) {
163                    result.setEntityLock(getEntityLockTransfer(basePK));
164                }
165
166                if(entityEntityAttribute != null) {
167                    result.setEntityEntityAttribute(coreControl.getEntityEntityAttributeTransfer(getUserVisit(), entityEntityAttribute, entityInstance));
168                }
169            }
170        }
171
172        return result;
173    }
174    
175}