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.security.server.command;
018
019import com.echothree.control.user.security.common.edit.PartySecurityRoleTemplateEdit;
020import com.echothree.control.user.security.common.edit.SecurityEditFactory;
021import com.echothree.control.user.security.common.form.EditPartySecurityRoleTemplateForm;
022import com.echothree.control.user.security.common.result.EditPartySecurityRoleTemplateResult;
023import com.echothree.control.user.security.common.result.SecurityResultFactory;
024import com.echothree.control.user.security.common.spec.PartySecurityRoleTemplateSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.control.security.server.control.SecurityControl;
029import com.echothree.model.data.security.server.entity.PartySecurityRoleTemplate;
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.List;
041import javax.enterprise.context.Dependent;
042
043@Dependent
044public class EditPartySecurityRoleTemplateCommand
045        extends BaseAbstractEditCommand<PartySecurityRoleTemplateSpec, PartySecurityRoleTemplateEdit, EditPartySecurityRoleTemplateResult, PartySecurityRoleTemplate, PartySecurityRoleTemplate> {
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.PartySecurityRoleTemplate.name(), SecurityRoles.Edit.name())
056                        ))
057                ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("PartySecurityRoleTemplateName", FieldType.ENTITY_NAME, true, null, null)
061                );
062        
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("PartySecurityRoleTemplateName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
066                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
067                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
068                );
069    }
070    
071    /** Creates a new instance of EditPartySecurityRoleTemplateCommand */
072    public EditPartySecurityRoleTemplateCommand() {
073        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
074    }
075    
076    @Override
077    public EditPartySecurityRoleTemplateResult getResult() {
078        return SecurityResultFactory.getEditPartySecurityRoleTemplateResult();
079    }
080    
081    @Override
082    public PartySecurityRoleTemplateEdit getEdit() {
083        return SecurityEditFactory.getPartySecurityRoleTemplateEdit();
084    }
085    
086    @Override
087    public PartySecurityRoleTemplate getEntity(EditPartySecurityRoleTemplateResult result) {
088        var securityControl = Session.getModelController(SecurityControl.class);
089        PartySecurityRoleTemplate partySecurityRoleTemplate;
090        var partySecurityRoleTemplateName = spec.getPartySecurityRoleTemplateName();
091
092        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
093            partySecurityRoleTemplate = securityControl.getPartySecurityRoleTemplateByName(partySecurityRoleTemplateName);
094        } else { // EditMode.UPDATE
095            partySecurityRoleTemplate = securityControl.getPartySecurityRoleTemplateByNameForUpdate(partySecurityRoleTemplateName);
096        }
097
098        if(partySecurityRoleTemplate != null) {
099            result.setPartySecurityRoleTemplate(securityControl.getPartySecurityRoleTemplateTransfer(getUserVisit(), partySecurityRoleTemplate));
100        } else {
101            addExecutionError(ExecutionErrors.UnknownPartySecurityRoleTemplateName.name(), partySecurityRoleTemplateName);
102        }
103
104        return partySecurityRoleTemplate;
105    }
106    
107    @Override
108    public PartySecurityRoleTemplate getLockEntity(PartySecurityRoleTemplate partySecurityRoleTemplate) {
109        return partySecurityRoleTemplate;
110    }
111    
112    @Override
113    public void fillInResult(EditPartySecurityRoleTemplateResult result, PartySecurityRoleTemplate partySecurityRoleTemplate) {
114        var securityControl = Session.getModelController(SecurityControl.class);
115        
116        result.setPartySecurityRoleTemplate(securityControl.getPartySecurityRoleTemplateTransfer(getUserVisit(), partySecurityRoleTemplate));
117    }
118    
119    @Override
120    public void doLock(PartySecurityRoleTemplateEdit edit, PartySecurityRoleTemplate partySecurityRoleTemplate) {
121        var securityControl = Session.getModelController(SecurityControl.class);
122        var partySecurityRoleTemplateDescription = securityControl.getPartySecurityRoleTemplateDescription(partySecurityRoleTemplate, getPreferredLanguage());
123        var partySecurityRoleTemplateDetail = partySecurityRoleTemplate.getLastDetail();
124        
125        edit.setPartySecurityRoleTemplateName(partySecurityRoleTemplateDetail.getPartySecurityRoleTemplateName());
126        edit.setIsDefault(partySecurityRoleTemplateDetail.getIsDefault().toString());
127        edit.setSortOrder(partySecurityRoleTemplateDetail.getSortOrder().toString());
128
129        if(partySecurityRoleTemplateDescription != null) {
130            edit.setDescription(partySecurityRoleTemplateDescription.getDescription());
131        }
132    }
133        
134    @Override
135    public void canUpdate(PartySecurityRoleTemplate partySecurityRoleTemplate) {
136        var securityControl = Session.getModelController(SecurityControl.class);
137        var partySecurityRoleTemplateName = edit.getPartySecurityRoleTemplateName();
138        var duplicatePartySecurityRoleTemplate = securityControl.getPartySecurityRoleTemplateByName(partySecurityRoleTemplateName);
139
140        if(duplicatePartySecurityRoleTemplate != null && !partySecurityRoleTemplate.equals(duplicatePartySecurityRoleTemplate)) {
141            addExecutionError(ExecutionErrors.DuplicatePartySecurityRoleTemplateName.name(), partySecurityRoleTemplateName);
142        }
143    }
144    
145    @Override
146    public void doUpdate(PartySecurityRoleTemplate partySecurityRoleTemplate) {
147        var securityControl = Session.getModelController(SecurityControl.class);
148        var partyPK = getPartyPK();
149        var partySecurityRoleTemplateDetailValue = securityControl.getPartySecurityRoleTemplateDetailValueForUpdate(partySecurityRoleTemplate);
150        var partySecurityRoleTemplateDescription = securityControl.getPartySecurityRoleTemplateDescriptionForUpdate(partySecurityRoleTemplate, getPreferredLanguage());
151        var description = edit.getDescription();
152
153        partySecurityRoleTemplateDetailValue.setPartySecurityRoleTemplateName(edit.getPartySecurityRoleTemplateName());
154        partySecurityRoleTemplateDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
155        partySecurityRoleTemplateDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
156
157        securityControl.updatePartySecurityRoleTemplateFromValue(partySecurityRoleTemplateDetailValue, partyPK);
158
159        if(partySecurityRoleTemplateDescription == null && description != null) {
160            securityControl.createPartySecurityRoleTemplateDescription(partySecurityRoleTemplate, getPreferredLanguage(), description, partyPK);
161        } else if(partySecurityRoleTemplateDescription != null && description == null) {
162            securityControl.deletePartySecurityRoleTemplateDescription(partySecurityRoleTemplateDescription, partyPK);
163        } else if(partySecurityRoleTemplateDescription != null && description != null) {
164            var partySecurityRoleTemplateDescriptionValue = securityControl.getPartySecurityRoleTemplateDescriptionValue(partySecurityRoleTemplateDescription);
165
166            partySecurityRoleTemplateDescriptionValue.setDescription(description);
167            securityControl.updatePartySecurityRoleTemplateDescriptionFromValue(partySecurityRoleTemplateDescriptionValue, partyPK);
168        }
169    }
170    
171}