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.EntityDateAttributeEdit;
021import com.echothree.control.user.core.common.form.EditEntityDateAttributeForm;
022import com.echothree.control.user.core.common.result.CoreResultFactory;
023import com.echothree.control.user.core.common.result.EditEntityDateAttributeResult;
024import com.echothree.control.user.core.common.spec.EntityDateAttributeSpec;
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.EntityDateAttribute;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.command.BaseResult;
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.BaseEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.persistence.PersistenceUtils;
039import com.echothree.util.server.string.DateUtils;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class EditEntityDateAttributeCommand
045        extends BaseEditCommand<EntityDateAttributeSpec, EntityDateAttributeEdit> {
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(), null)
055        ));
056
057        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
059                new FieldDefinition("Key", FieldType.KEY, false, null, null),
060                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
061                new FieldDefinition("Ulid", FieldType.ULID, false, null, null),
062                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, false, null, null),
063                new FieldDefinition("EntityAttributeUlid", FieldType.ULID, false, null, null)
064                ));
065        
066        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
067                new FieldDefinition("DateAttribute", FieldType.DATE, true, null, null)
068                ));
069    }
070    
071    /** Creates a new instance of EditEntityDateAttributeCommand */
072    public EditEntityDateAttributeCommand(UserVisitPK userVisitPK, EditEntityDateAttributeForm form) {
073        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
074    }
075    
076    @Override
077    protected BaseResult execute() {
078        EditEntityDateAttributeResult result = CoreResultFactory.getEditEntityDateAttributeResult();
079        var parameterCount = EntityInstanceLogic.getInstance().countPossibleEntitySpecs(spec);
080
081        if(parameterCount == 1) {
082            var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, spec);
083
084            if(!hasExecutionErrors()) {
085                var entityAttributeName = spec.getEntityAttributeName();
086                var entityAttributeUlid = spec.getEntityAttributeUlid();
087
088                parameterCount = (entityAttributeName == null ? 0 : 1) + (entityAttributeUlid == null ? 0 : 1);
089
090                if(parameterCount == 1) {
091                    var entityAttribute = entityAttributeName == null ?
092                            EntityAttributeLogic.getInstance().getEntityAttributeByUlid(this, entityAttributeUlid) :
093                            EntityAttributeLogic.getInstance().getEntityAttributeByName(this, entityInstance.getEntityType(), entityAttributeName);
094
095                    if(!hasExecutionErrors()) {
096                        if(entityInstance.getEntityType().equals(entityAttribute.getLastDetail().getEntityType())) {
097                            var coreControl = getCoreControl();
098                            EntityDateAttribute entityDateAttribute = null;
099                            var basePK = PersistenceUtils.getInstance().getBasePKFromEntityInstance(entityInstance);
100
101                            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
102                                entityDateAttribute = coreControl.getEntityDateAttribute(entityAttribute, entityInstance);
103
104                                if(entityDateAttribute != null) {
105                                    if(editMode.equals(EditMode.LOCK)) {
106                                        result.setEntityDateAttribute(coreControl.getEntityDateAttributeTransfer(getUserVisit(),
107                                                entityDateAttribute, entityInstance));
108
109                                        if(lockEntity(basePK)) {
110                                            var edit = CoreEditFactory.getEntityDateAttributeEdit();
111
112                                            result.setEdit(edit);
113                                            edit.setDateAttribute(DateUtils.getInstance().formatDate(getUserVisit(), entityDateAttribute.getDateAttribute()));
114                                        } else {
115                                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
116                                        }
117                                    } else { // EditMode.ABANDON
118                                        unlockEntity(basePK);
119                                        basePK = null;
120                                    }
121                                } else {
122                                    addExecutionError(ExecutionErrors.UnknownEntityDateAttribute.name(),
123                                            EntityInstanceLogic.getInstance().getEntityRefFromEntityInstance(entityInstance), entityAttributeName);
124                                }
125                            } else if(editMode.equals(EditMode.UPDATE)) {
126                                entityDateAttribute = coreControl.getEntityDateAttributeForUpdate(entityAttribute, entityInstance);
127
128                                if(entityDateAttribute != null) {
129                                    if(lockEntityForUpdate(basePK)) {
130                                        try {
131                                            var entityDateAttributeValue = coreControl.getEntityDateAttributeValueForUpdate(entityDateAttribute);
132
133                                            entityDateAttributeValue.setDateAttribute(Integer.valueOf(edit.getDateAttribute()));
134
135                                            coreControl.updateEntityDateAttributeFromValue(entityDateAttributeValue, getPartyPK());
136                                        } finally {
137                                            unlockEntity(basePK);
138                                            basePK = null;
139                                        }
140                                    } else {
141                                        addExecutionError(ExecutionErrors.EntityLockStale.name());
142                                    }
143                                } else {
144                                    addExecutionError(ExecutionErrors.UnknownEntityDateAttribute.name(),
145                                            EntityInstanceLogic.getInstance().getEntityRefFromEntityInstance(entityInstance), entityAttributeName);
146                                }
147                            }
148
149                            if(basePK != null) {
150                                result.setEntityLock(getEntityLockTransfer(basePK));
151                            }
152
153                            if(entityDateAttribute != null) {
154                                result.setEntityDateAttribute(coreControl.getEntityDateAttributeTransfer(getUserVisit(), entityDateAttribute, entityInstance));
155                            }
156                        } else {
157                            addExecutionError(ExecutionErrors.MismatchedEntityType.name());
158                        }
159                    }
160                } else {
161                    addExecutionError(ExecutionErrors.InvalidParameterCount.name());
162                }
163            }
164        } else {
165            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
166        }
167
168        return result;
169    }
170    
171}