001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.chain.server.command;
018
019import com.echothree.control.user.chain.common.edit.ChainEditFactory;
020import com.echothree.control.user.chain.common.edit.ChainKindEdit;
021import com.echothree.control.user.chain.common.form.EditChainKindForm;
022import com.echothree.control.user.chain.common.result.ChainResultFactory;
023import com.echothree.control.user.chain.common.result.EditChainKindResult;
024import com.echothree.control.user.chain.common.spec.ChainKindSpec;
025import com.echothree.model.control.chain.server.control.ChainControl;
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.chain.server.entity.ChainKind;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.EditMode;
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 com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043import javax.enterprise.context.RequestScoped;
044
045@RequestScoped
046public class EditChainKindCommand
047        extends BaseAbstractEditCommand<ChainKindSpec, ChainKindEdit, EditChainKindResult, ChainKind, ChainKind> {
048
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
057                        new SecurityRoleDefinition(SecurityRoleGroups.ChainKind.name(), SecurityRoles.Edit.name())
058                        )))
059                )));
060
061        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
062                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null)
063                ));
064
065        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
066                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
068                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
069                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
070                ));
071    }
072
073    /** Creates a new instance of EditChainKindCommand */
074    public EditChainKindCommand() {
075        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077
078    @Override
079    public EditChainKindResult getResult() {
080        return ChainResultFactory.getEditChainKindResult();
081    }
082
083    @Override
084    public ChainKindEdit getEdit() {
085        return ChainEditFactory.getChainKindEdit();
086    }
087
088    @Override
089    public ChainKind getEntity(EditChainKindResult result) {
090        var chainControl = Session.getModelController(ChainControl.class);
091        ChainKind chainKind;
092        var chainKindName = spec.getChainKindName();
093
094        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
095            chainKind = chainControl.getChainKindByName(chainKindName);
096        } else { // EditMode.UPDATE
097            chainKind = chainControl.getChainKindByNameForUpdate(chainKindName);
098        }
099
100        if(chainKind == null) {
101            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
102        }
103
104        return chainKind;
105    }
106
107    @Override
108    public ChainKind getLockEntity(ChainKind chainKind) {
109        return chainKind;
110    }
111
112    @Override
113    public void fillInResult(EditChainKindResult result, ChainKind chainKind) {
114        var chainControl = Session.getModelController(ChainControl.class);
115
116        result.setChainKind(chainControl.getChainKindTransfer(getUserVisit(), chainKind));
117    }
118
119    @Override
120    public void doLock(ChainKindEdit edit, ChainKind chainKind) {
121        var chainControl = Session.getModelController(ChainControl.class);
122        var chainKindDescription = chainControl.getChainKindDescription(chainKind, getPreferredLanguage());
123        var chainKindDetail = chainKind.getLastDetail();
124
125        edit.setChainKindName(chainKindDetail.getChainKindName());
126        edit.setIsDefault(chainKindDetail.getIsDefault().toString());
127        edit.setSortOrder(chainKindDetail.getSortOrder().toString());
128
129        if(chainKindDescription != null) {
130            edit.setDescription(chainKindDescription.getDescription());
131        }
132    }
133
134    @Override
135    public void canUpdate(ChainKind chainKind) {
136        var chainControl = Session.getModelController(ChainControl.class);
137        var chainKindName = edit.getChainKindName();
138        var duplicateChainKind = chainControl.getChainKindByName(chainKindName);
139
140        if(duplicateChainKind != null && !chainKind.equals(duplicateChainKind)) {
141            addExecutionError(ExecutionErrors.DuplicateChainKindName.name(), chainKindName);
142        }
143    }
144
145    @Override
146    public void doUpdate(ChainKind chainKind) {
147        var chainControl = Session.getModelController(ChainControl.class);
148        var partyPK = getPartyPK();
149        var chainKindDetailValue = chainControl.getChainKindDetailValueForUpdate(chainKind);
150        var chainKindDescription = chainControl.getChainKindDescriptionForUpdate(chainKind, getPreferredLanguage());
151        var description = edit.getDescription();
152
153        chainKindDetailValue.setChainKindName(edit.getChainKindName());
154        chainKindDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
155        chainKindDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
156
157        chainControl.updateChainKindFromValue(chainKindDetailValue, partyPK);
158
159        if(chainKindDescription == null && description != null) {
160            chainControl.createChainKindDescription(chainKind, getPreferredLanguage(), description, partyPK);
161        } else if(chainKindDescription != null && description == null) {
162            chainControl.deleteChainKindDescription(chainKindDescription, partyPK);
163        } else if(chainKindDescription != null && description != null) {
164            var chainKindDescriptionValue = chainControl.getChainKindDescriptionValue(chainKindDescription);
165
166            chainKindDescriptionValue.setDescription(description);
167            chainControl.updateChainKindDescriptionFromValue(chainKindDescriptionValue, partyPK);
168        }
169    }
170
171}