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.EntityAttributeEntityAttributeGroupEdit;
021import com.echothree.control.user.core.common.form.EditEntityAttributeEntityAttributeGroupForm;
022import com.echothree.control.user.core.common.result.CoreResultFactory;
023import com.echothree.control.user.core.common.result.EditEntityAttributeEntityAttributeGroupResult;
024import com.echothree.control.user.core.common.spec.EntityAttributeEntityAttributeGroupSpec;
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.EntityAttributeDetail;
031import com.echothree.model.data.core.server.entity.EntityAttributeEntityAttributeGroup;
032import com.echothree.model.data.core.server.entity.EntityAttributeGroup;
033import com.echothree.model.data.core.server.entity.EntityTypeDetail;
034import com.echothree.model.data.core.server.value.EntityAttributeEntityAttributeGroupValue;
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 java.util.Arrays;
045import java.util.Collections;
046import java.util.List;
047
048public class EditEntityAttributeEntityAttributeGroupCommand
049        extends BaseAbstractEditCommand<EntityAttributeEntityAttributeGroupSpec, EntityAttributeEntityAttributeGroupEdit, EditEntityAttributeEntityAttributeGroupResult, EntityAttributeEntityAttributeGroup, EntityAttribute> {
050    
051    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
052    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
053    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
054    
055    static {
056        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
057                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
058                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
059                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttribute.name(), SecurityRoles.EntityAttributeEntityAttributeGroup.name())
060                        )))
061                )));
062        
063        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
064                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
066                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("EntityAttributeGroupName", FieldType.ENTITY_NAME, true, null, null)
068                ));
069        
070        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
071                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null)
072                ));
073    }
074    
075    /** Creates a new instance of EditEntityAttributeEntityAttributeGroupCommand */
076    public EditEntityAttributeEntityAttributeGroupCommand(UserVisitPK userVisitPK, EditEntityAttributeEntityAttributeGroupForm form) {
077        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079    
080    @Override
081    public EditEntityAttributeEntityAttributeGroupResult getResult() {
082        return CoreResultFactory.getEditEntityAttributeEntityAttributeGroupResult();
083    }
084
085    @Override
086    public EntityAttributeEntityAttributeGroupEdit getEdit() {
087        return CoreEditFactory.getEntityAttributeEntityAttributeGroupEdit();
088    }
089
090    @Override
091    public EntityAttributeEntityAttributeGroup getEntity(EditEntityAttributeEntityAttributeGroupResult result) {
092        EntityAttributeEntityAttributeGroup entityAttributeEntityAttributeGroup = null;
093        EntityAttribute entityAttribute = EntityAttributeLogic.getInstance().getEntityAttributeByName(this, spec.getComponentVendorName(), spec.getEntityTypeName(), spec.getEntityAttributeName());
094        
095        if(!hasExecutionErrors()) {
096            EntityAttributeGroup entityAttributeGroup = EntityAttributeLogic.getInstance().getEntityAttributeGroupByName(this, spec.getEntityAttributeGroupName());
097            
098            if(!hasExecutionErrors()) {
099                var coreControl = getCoreControl();
100
101                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
102                    entityAttributeEntityAttributeGroup = coreControl.getEntityAttributeEntityAttributeGroup(entityAttribute, entityAttributeGroup);
103                } else { // EditMode.UPDATE
104                    entityAttributeEntityAttributeGroup = coreControl.getEntityAttributeEntityAttributeGroupForUpdate(entityAttribute, entityAttributeGroup);
105                }
106
107                if(entityAttributeEntityAttributeGroup == null) {
108                    EntityAttributeDetail entityAttributeDetail = entityAttribute.getLastDetail();
109                    EntityTypeDetail entityTypeDetail = entityAttributeDetail.getEntityType().getLastDetail();
110                    
111                    addExecutionError(ExecutionErrors.UnknownEntityAttributeEntityAttributeGroup.name(),
112                            entityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName(), entityTypeDetail.getEntityTypeName(),
113                            entityAttributeDetail.getEntityAttributeName(), entityAttributeGroup.getLastDetail().getEntityAttributeGroupName());
114                }
115            }
116        }
117        
118        return entityAttributeEntityAttributeGroup;
119    }
120
121    @Override
122    public EntityAttribute getLockEntity(EntityAttributeEntityAttributeGroup entityAttributeEntityAttributeGroup) {
123        return entityAttributeEntityAttributeGroup.getEntityAttribute();
124    }
125
126    @Override
127    public void fillInResult(EditEntityAttributeEntityAttributeGroupResult result, EntityAttributeEntityAttributeGroup entityAttributeEntityAttributeGroup) {
128        var coreControl = getCoreControl();
129
130        result.setEntityAttributeEntityAttributeGroup(coreControl.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 coreControl = getCoreControl();
141        EntityAttributeEntityAttributeGroupValue entityAttributeEntityAttributeGroupValue = coreControl.getEntityAttributeEntityAttributeGroupValue(entityAttributeEntityAttributeGroup);
142        
143        entityAttributeEntityAttributeGroupValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
144
145        coreControl.updateEntityAttributeEntityAttributeGroupFromValue(entityAttributeEntityAttributeGroupValue, getPartyPK());
146    }
147    
148}