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