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
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.EntityAttributeDescriptionEdit;
021import com.echothree.control.user.core.common.form.EditEntityAttributeDescriptionForm;
022import com.echothree.control.user.core.common.result.CoreResultFactory;
023import com.echothree.control.user.core.common.result.EditEntityAttributeDescriptionResult;
024import com.echothree.control.user.core.common.spec.EntityAttributeDescriptionSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.core.server.entity.EntityAttribute;
030import com.echothree.model.data.core.server.entity.EntityAttributeDescription;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.EditMode;
036import com.echothree.util.server.control.BaseAbstractEditCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042import javax.inject.Inject;
043
044@Dependent
045public class EditEntityAttributeDescriptionCommand
046        extends BaseAbstractEditCommand<EntityAttributeDescriptionSpec, EntityAttributeDescriptionEdit, EditEntityAttributeDescriptionResult, EntityAttributeDescription, EntityAttribute> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
050    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
051    
052    static {
053        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
056                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttribute.name(), SecurityRoles.Description.name())
057                ))
058        ));
059        
060        SPEC_FIELD_DEFINITIONS = List.of(
061                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
063                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
065        );
066        
067        EDIT_FIELD_DEFINITIONS = List.of(
068                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
069        );
070    }
071
072    @Inject
073    PartyControl partyControl;
074
075    
076    /** Creates a new instance of EditEntityAttributeDescriptionCommand */
077    public EditEntityAttributeDescriptionCommand() {
078        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080    
081    @Override
082    public EditEntityAttributeDescriptionResult getResult() {
083        return CoreResultFactory.getEditEntityAttributeDescriptionResult();
084    }
085
086    @Override
087    public EntityAttributeDescriptionEdit getEdit() {
088        return CoreEditFactory.getEntityAttributeDescriptionEdit();
089    }
090
091    @Override
092    public EntityAttributeDescription getEntity(EditEntityAttributeDescriptionResult result) {
093        EntityAttributeDescription entityAttributeDescription = null;
094        var componentVendorName = spec.getComponentVendorName();
095        var componentVendor = componentControl.getComponentVendorByName(componentVendorName);
096
097        if(componentVendor != null) {
098            var entityTypeName = spec.getEntityTypeName();
099            var entityType = entityTypeControl.getEntityTypeByName(componentVendor, entityTypeName);
100
101            if(entityType != null) {
102                var entityAttributeName = spec.getEntityAttributeName();
103                var entityAttribute = coreControl.getEntityAttributeByName(entityType, entityAttributeName);
104
105                if(entityAttribute != null) {
106                    var languageIsoName = spec.getLanguageIsoName();
107                    var language = partyControl.getLanguageByIsoName(languageIsoName);
108
109                    if(language != null) {
110                        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
111                            entityAttributeDescription = coreControl.getEntityAttributeDescription(entityAttribute, language);
112                        } else { // EditMode.UPDATE
113                            entityAttributeDescription = coreControl.getEntityAttributeDescriptionForUpdate(entityAttribute, language);
114                        }
115
116                        if(entityAttributeDescription == null) {
117                            addExecutionError(ExecutionErrors.UnknownEntityAttributeDescription.name(), componentVendorName, entityTypeName, entityAttributeName, entityAttributeName, languageIsoName);
118                        }
119                    } else {
120                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
121                    }
122                } else {
123                    addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), componentVendorName, entityTypeName, entityAttributeName);
124                }
125            } else {
126                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), componentVendorName, entityTypeName);
127            }
128        } else {
129            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
130        }
131
132        return entityAttributeDescription;
133    }
134
135    @Override
136    public EntityAttribute getLockEntity(EntityAttributeDescription entityAttributeDescription) {
137        return entityAttributeDescription.getEntityAttribute();
138    }
139
140    @Override
141    public void fillInResult(EditEntityAttributeDescriptionResult result, EntityAttributeDescription entityAttributeDescription) {
142
143        result.setEntityAttributeDescription(coreControl.getEntityAttributeDescriptionTransfer(getUserVisit(), entityAttributeDescription, null));
144    }
145
146    @Override
147    public void doLock(EntityAttributeDescriptionEdit edit, EntityAttributeDescription entityAttributeDescription) {
148        edit.setDescription(entityAttributeDescription.getDescription());
149    }
150
151    @Override
152    public void doUpdate(EntityAttributeDescription entityAttributeDescription) {
153        var entityAttributeDescriptionValue = coreControl.getEntityAttributeDescriptionValue(entityAttributeDescription);
154        entityAttributeDescriptionValue.setDescription(edit.getDescription());
155
156        coreControl.updateEntityAttributeDescriptionFromValue(entityAttributeDescriptionValue, getPartyPK());
157    }
158    
159}