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
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.ComponentVendor;
030import com.echothree.model.data.core.server.entity.EntityAttribute;
031import com.echothree.model.data.core.server.entity.EntityAttributeDescription;
032import com.echothree.model.data.core.server.entity.EntityType;
033import com.echothree.model.data.core.server.value.EntityAttributeDescriptionValue;
034import com.echothree.model.data.party.server.entity.Language;
035import com.echothree.model.data.user.common.pk.UserVisitPK;
036import com.echothree.util.common.message.ExecutionErrors;
037import com.echothree.util.common.validation.FieldDefinition;
038import com.echothree.util.common.validation.FieldType;
039import com.echothree.util.common.command.EditMode;
040import com.echothree.util.server.control.BaseAbstractEditCommand;
041import com.echothree.util.server.control.CommandSecurityDefinition;
042import com.echothree.util.server.control.PartyTypeDefinition;
043import com.echothree.util.server.control.SecurityRoleDefinition;
044import com.echothree.util.server.persistence.Session;
045import java.util.Arrays;
046import java.util.Collections;
047import java.util.List;
048
049public class EditEntityAttributeDescriptionCommand
050        extends BaseAbstractEditCommand<EntityAttributeDescriptionSpec, EntityAttributeDescriptionEdit, EditEntityAttributeDescriptionResult, EntityAttributeDescription, EntityAttribute> {
051    
052    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
053    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
054    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
055    
056    static {
057        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
060                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttribute.name(), SecurityRoles.Description.name())
061                        )))
062                )));
063        
064        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
065                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
067                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
069                ));
070        
071        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
072                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
073                ));
074    }
075    
076    /** Creates a new instance of EditEntityAttributeDescriptionCommand */
077    public EditEntityAttributeDescriptionCommand(UserVisitPK userVisitPK, EditEntityAttributeDescriptionForm form) {
078        super(userVisitPK, form, 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        var coreControl = getCoreControl();
094        EntityAttributeDescription entityAttributeDescription = null;
095        String componentVendorName = spec.getComponentVendorName();
096        ComponentVendor componentVendor = coreControl.getComponentVendorByName(componentVendorName);
097
098        if(componentVendor != null) {
099            String entityTypeName = spec.getEntityTypeName();
100            EntityType entityType = coreControl.getEntityTypeByName(componentVendor, entityTypeName);
101
102            if(entityType != null) {
103                String entityAttributeName = spec.getEntityAttributeName();
104                EntityAttribute entityAttribute = coreControl.getEntityAttributeByName(entityType, entityAttributeName);
105
106                if(entityAttribute != null) {
107                    var partyControl = Session.getModelController(PartyControl.class);
108                    String languageIsoName = spec.getLanguageIsoName();
109                    Language language = partyControl.getLanguageByIsoName(languageIsoName);
110
111                    if(language != null) {
112                        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
113                            entityAttributeDescription = coreControl.getEntityAttributeDescription(entityAttribute, language);
114                        } else { // EditMode.UPDATE
115                            entityAttributeDescription = coreControl.getEntityAttributeDescriptionForUpdate(entityAttribute, language);
116                        }
117
118                        if(entityAttributeDescription == null) {
119                            addExecutionError(ExecutionErrors.UnknownEntityAttributeDescription.name(), componentVendorName, entityTypeName, entityAttributeName, entityAttributeName, languageIsoName);
120                        }
121                    } else {
122                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
123                    }
124                } else {
125                    addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), componentVendorName, entityTypeName, entityAttributeName);
126                }
127            } else {
128                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), componentVendorName, entityTypeName);
129            }
130        } else {
131            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
132        }
133
134        return entityAttributeDescription;
135    }
136
137    @Override
138    public EntityAttribute getLockEntity(EntityAttributeDescription entityAttributeDescription) {
139        return entityAttributeDescription.getEntityAttribute();
140    }
141
142    @Override
143    public void fillInResult(EditEntityAttributeDescriptionResult result, EntityAttributeDescription entityAttributeDescription) {
144        var coreControl = getCoreControl();
145
146        result.setEntityAttributeDescription(coreControl.getEntityAttributeDescriptionTransfer(getUserVisit(), entityAttributeDescription, null));
147    }
148
149    @Override
150    public void doLock(EntityAttributeDescriptionEdit edit, EntityAttributeDescription entityAttributeDescription) {
151        edit.setDescription(entityAttributeDescription.getDescription());
152    }
153
154    @Override
155    public void doUpdate(EntityAttributeDescription entityAttributeDescription) {
156        var coreControl = getCoreControl();
157        EntityAttributeDescriptionValue entityAttributeDescriptionValue = coreControl.getEntityAttributeDescriptionValue(entityAttributeDescription);
158        entityAttributeDescriptionValue.setDescription(edit.getDescription());
159
160        coreControl.updateEntityAttributeDescriptionFromValue(entityAttributeDescriptionValue, getPartyPK());
161    }
162    
163}