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.EntityBooleanAttributeEdit;
021import com.echothree.control.user.core.common.form.EditEntityBooleanAttributeForm;
022import com.echothree.control.user.core.common.result.CoreResultFactory;
023import com.echothree.control.user.core.common.result.EditEntityBooleanAttributeResult;
024import com.echothree.control.user.core.common.spec.EntityBooleanAttributeSpec;
025import com.echothree.model.control.core.server.logic.EntityAttributeLogic;
026import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.data.core.server.entity.EntityAttribute;
029import com.echothree.model.data.core.server.entity.EntityBooleanAttribute;
030import com.echothree.model.data.core.server.entity.EntityInstance;
031import com.echothree.model.data.core.server.value.EntityBooleanAttributeValue;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.common.command.BaseResult;
037import com.echothree.util.common.command.EditMode;
038import com.echothree.util.common.persistence.BasePK;
039import com.echothree.util.server.control.BaseEditCommand;
040import com.echothree.util.server.control.CommandSecurityDefinition;
041import com.echothree.util.server.control.PartyTypeDefinition;
042import com.echothree.util.server.persistence.PersistenceUtils;
043import java.util.Arrays;
044import java.util.Collections;
045import java.util.List;
046
047public class EditEntityBooleanAttributeCommand
048        extends BaseEditCommand<EntityBooleanAttributeSpec, EntityBooleanAttributeEdit> {
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(List.of(
056                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
057                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), null)
058        ));
059
060        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
061                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
062                new FieldDefinition("Key", FieldType.KEY, false, null, null),
063                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
064                new FieldDefinition("Ulid", FieldType.ULID, false, null, null),
065                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, false, null, null),
066                new FieldDefinition("EntityAttributeUlid", FieldType.ULID, false, null, null)
067                ));
068        
069        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
070                new FieldDefinition("BooleanAttribute", FieldType.BOOLEAN, true, null, null)
071                ));
072    }
073    
074    /** Creates a new instance of EditEntityBooleanAttributeCommand */
075    public EditEntityBooleanAttributeCommand(UserVisitPK userVisitPK, EditEntityBooleanAttributeForm form) {
076        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
077    }
078    
079    @Override
080    protected BaseResult execute() {
081        EditEntityBooleanAttributeResult result = CoreResultFactory.getEditEntityBooleanAttributeResult();
082        var parameterCount = EntityInstanceLogic.getInstance().countPossibleEntitySpecs(spec);
083
084        if(parameterCount == 1) {
085            var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, spec);
086
087            if(!hasExecutionErrors()) {
088                String entityAttributeName = spec.getEntityAttributeName();
089                String entityAttributeUlid = spec.getEntityAttributeUlid();
090                
091                parameterCount = (entityAttributeName == null ? 0 : 1) + (entityAttributeUlid == null ? 0 : 1);
092                
093                if(parameterCount == 1) {
094                    EntityAttribute entityAttribute = entityAttributeName == null ?
095                            EntityAttributeLogic.getInstance().getEntityAttributeByUlid(this, entityAttributeUlid) :
096                            EntityAttributeLogic.getInstance().getEntityAttributeByName(this, entityInstance.getEntityType(), entityAttributeName);
097
098                    if(!hasExecutionErrors()) {
099                        if(entityInstance.getEntityType().equals(entityAttribute.getLastDetail().getEntityType())) {
100                            var coreControl = getCoreControl();
101                            EntityBooleanAttribute entityBooleanAttribute = null;
102                            BasePK basePK = PersistenceUtils.getInstance().getBasePKFromEntityInstance(entityInstance);
103
104                            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
105                                entityBooleanAttribute = coreControl.getEntityBooleanAttribute(entityAttribute, entityInstance);
106
107                                if(entityBooleanAttribute != null) {
108                                    if(editMode.equals(EditMode.LOCK)) {
109                                        result.setEntityBooleanAttribute(coreControl.getEntityBooleanAttributeTransfer(getUserVisit(), entityBooleanAttribute, entityInstance));
110
111                                        if(lockEntity(basePK)) {
112                                            EntityBooleanAttributeEdit edit = CoreEditFactory.getEntityBooleanAttributeEdit();
113
114                                            result.setEdit(edit);
115                                            edit.setBooleanAttribute(entityBooleanAttribute.getBooleanAttribute().toString());
116                                        } else {
117                                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
118                                        }
119                                    } else { // EditMode.ABANDON
120                                        unlockEntity(basePK);
121                                        basePK = null;
122                                    }
123                                } else {
124                                    addExecutionError(ExecutionErrors.UnknownEntityBooleanAttribute.name(),
125                                            EntityInstanceLogic.getInstance().getEntityRefFromEntityInstance(entityInstance), entityAttributeName);
126                                }
127                            } else if(editMode.equals(EditMode.UPDATE)) {
128                                entityBooleanAttribute = coreControl.getEntityBooleanAttributeForUpdate(entityAttribute, entityInstance);
129
130                                if(entityBooleanAttribute != null) {
131                                    if(lockEntityForUpdate(basePK)) {
132                                        try {
133                                            EntityBooleanAttributeValue entityBooleanAttributeValue = coreControl.getEntityBooleanAttributeValueForUpdate(entityBooleanAttribute);
134
135                                            entityBooleanAttributeValue.setBooleanAttribute(Boolean.valueOf(edit.getBooleanAttribute()));
136
137                                            coreControl.updateEntityBooleanAttributeFromValue(entityBooleanAttributeValue, getPartyPK());
138                                        } finally {
139                                            unlockEntity(basePK);
140                                            basePK = null;
141                                        }
142                                    } else {
143                                        addExecutionError(ExecutionErrors.EntityLockStale.name());
144                                    }
145                                } else {
146                                    addExecutionError(ExecutionErrors.UnknownEntityBooleanAttribute.name(),
147                                            EntityInstanceLogic.getInstance().getEntityRefFromEntityInstance(entityInstance), entityAttributeName);
148                                }
149                            }
150
151                            if(basePK != null) {
152                                result.setEntityLock(getEntityLockTransfer(basePK));
153                            }
154
155                            if(entityBooleanAttribute != null) {
156                                result.setEntityBooleanAttribute(coreControl.getEntityBooleanAttributeTransfer(getUserVisit(), entityBooleanAttribute, entityInstance));
157                            }
158                        } else {
159                            addExecutionError(ExecutionErrors.MismatchedEntityType.name());
160                        }
161                    }
162                } else {
163                    addExecutionError(ExecutionErrors.InvalidParameterCount.name());
164                }
165            }
166        } else {
167            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
168        }
169
170        return result;
171    }
172    
173}