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.EntityAttributeEntityAttributeGroupEdit;
021import com.echothree.control.user.core.common.result.CoreResultFactory;
022import com.echothree.control.user.core.common.result.EditEntityAttributeEntityAttributeGroupResult;
023import com.echothree.control.user.core.common.spec.EntityAttributeEntityAttributeGroupSpec;
024import com.echothree.model.control.core.server.control.EntityAttributeGroupControl;
025import com.echothree.model.control.core.server.logic.EntityAttributeLogic;
026import com.echothree.model.control.party.common.PartyTypes;
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.EntityAttributeEntityAttributeGroup;
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.BaseAbstractEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class EditEntityAttributeEntityAttributeGroupCommand
045        extends BaseAbstractEditCommand<EntityAttributeEntityAttributeGroupSpec, EntityAttributeEntityAttributeGroupEdit, EditEntityAttributeEntityAttributeGroupResult, EntityAttributeEntityAttributeGroup, EntityAttribute> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttribute.name(), SecurityRoles.EntityAttributeEntityAttributeGroup.name())
056                ))
057        ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
062                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("EntityAttributeGroupName", FieldType.ENTITY_NAME, true, null, null)
064        );
065        
066        EDIT_FIELD_DEFINITIONS = List.of(
067                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null)
068        );
069    }
070
071    @Inject
072    protected EntityAttributeGroupControl entityAttributeGroupControl;
073
074    @Inject
075    EntityAttributeLogic entityAttributeLogic;
076
077    
078    /** Creates a new instance of EditEntityAttributeEntityAttributeGroupCommand */
079    public EditEntityAttributeEntityAttributeGroupCommand() {
080        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
081    }
082    
083    @Override
084    public EditEntityAttributeEntityAttributeGroupResult getResult() {
085        return CoreResultFactory.getEditEntityAttributeEntityAttributeGroupResult();
086    }
087
088    @Override
089    public EntityAttributeEntityAttributeGroupEdit getEdit() {
090        return CoreEditFactory.getEntityAttributeEntityAttributeGroupEdit();
091    }
092
093    @Override
094    public EntityAttributeEntityAttributeGroup getEntity(EditEntityAttributeEntityAttributeGroupResult result) {
095        EntityAttributeEntityAttributeGroup entityAttributeEntityAttributeGroup = null;
096        var entityAttribute = entityAttributeLogic.getEntityAttributeByName(this, spec.getComponentVendorName(), spec.getEntityTypeName(), spec.getEntityAttributeName());
097        
098        if(!hasExecutionErrors()) {
099            var entityAttributeGroup = entityAttributeLogic.getEntityAttributeGroupByName(this, entityAttribute.getLastDetail().getEntityType(), spec.getEntityAttributeGroupName());
100            
101            if(!hasExecutionErrors()) {
102                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
103                    entityAttributeEntityAttributeGroup = entityAttributeGroupControl.getEntityAttributeEntityAttributeGroup(entityAttribute, entityAttributeGroup);
104                } else { // EditMode.UPDATE
105                    entityAttributeEntityAttributeGroup = entityAttributeGroupControl.getEntityAttributeEntityAttributeGroupForUpdate(entityAttribute, entityAttributeGroup);
106                }
107
108                if(entityAttributeEntityAttributeGroup == null) {
109                    var entityAttributeDetail = entityAttribute.getLastDetail();
110                    var entityTypeDetail = entityAttributeDetail.getEntityType().getLastDetail();
111                    
112                    addExecutionError(ExecutionErrors.UnknownEntityAttributeEntityAttributeGroup.name(),
113                            entityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName(), entityTypeDetail.getEntityTypeName(),
114                            entityAttributeDetail.getEntityAttributeName(), entityAttributeGroup.getLastDetail().getEntityAttributeGroupName());
115                }
116            }
117        }
118        
119        return entityAttributeEntityAttributeGroup;
120    }
121
122    @Override
123    public EntityAttribute getLockEntity(EntityAttributeEntityAttributeGroup entityAttributeEntityAttributeGroup) {
124        return entityAttributeEntityAttributeGroup.getEntityAttribute();
125    }
126
127    @Override
128    public void fillInResult(EditEntityAttributeEntityAttributeGroupResult result, EntityAttributeEntityAttributeGroup entityAttributeEntityAttributeGroup) {
129
130        result.setEntityAttributeEntityAttributeGroup(entityAttributeGroupControl.getEntityAttributeEntityAttributeGroupTransfer(getUserVisit(), entityAttributeEntityAttributeGroup, null));
131    }
132
133    @Override
134    public void doLock(EntityAttributeEntityAttributeGroupEdit edit, EntityAttributeEntityAttributeGroup entityAttributeEntityAttributeGroup) {
135        edit.setSortOrder(entityAttributeEntityAttributeGroup.getSortOrder().toString());
136    }
137
138    @Override
139    public void doUpdate(EntityAttributeEntityAttributeGroup entityAttributeEntityAttributeGroup) {
140        var entityAttributeEntityAttributeGroupValue = entityAttributeGroupControl.getEntityAttributeEntityAttributeGroupValue(entityAttributeEntityAttributeGroup);
141        
142        entityAttributeEntityAttributeGroupValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
143
144        entityAttributeGroupControl.updateEntityAttributeEntityAttributeGroupFromValue(entityAttributeEntityAttributeGroupValue, getPartyPK());
145    }
146    
147}