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 java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
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    @Inject
072    SecurityControl securityControl;
073
074    
075    /** Creates a new instance of EditPartySecurityRoleTemplateCommand */
076    public EditPartySecurityRoleTemplateCommand() {
077        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079    
080    @Override
081    public EditPartySecurityRoleTemplateResult getResult() {
082        return SecurityResultFactory.getEditPartySecurityRoleTemplateResult();
083    }
084    
085    @Override
086    public PartySecurityRoleTemplateEdit getEdit() {
087        return SecurityEditFactory.getPartySecurityRoleTemplateEdit();
088    }
089    
090    @Override
091    public PartySecurityRoleTemplate getEntity(EditPartySecurityRoleTemplateResult result) {
092        PartySecurityRoleTemplate partySecurityRoleTemplate;
093        var partySecurityRoleTemplateName = spec.getPartySecurityRoleTemplateName();
094
095        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
096            partySecurityRoleTemplate = securityControl.getPartySecurityRoleTemplateByName(partySecurityRoleTemplateName);
097        } else { // EditMode.UPDATE
098            partySecurityRoleTemplate = securityControl.getPartySecurityRoleTemplateByNameForUpdate(partySecurityRoleTemplateName);
099        }
100
101        if(partySecurityRoleTemplate != null) {
102            result.setPartySecurityRoleTemplate(securityControl.getPartySecurityRoleTemplateTransfer(getUserVisit(), partySecurityRoleTemplate));
103        } else {
104            addExecutionError(ExecutionErrors.UnknownPartySecurityRoleTemplateName.name(), partySecurityRoleTemplateName);
105        }
106
107        return partySecurityRoleTemplate;
108    }
109    
110    @Override
111    public PartySecurityRoleTemplate getLockEntity(PartySecurityRoleTemplate partySecurityRoleTemplate) {
112        return partySecurityRoleTemplate;
113    }
114    
115    @Override
116    public void fillInResult(EditPartySecurityRoleTemplateResult result, PartySecurityRoleTemplate partySecurityRoleTemplate) {
117        result.setPartySecurityRoleTemplate(securityControl.getPartySecurityRoleTemplateTransfer(getUserVisit(), partySecurityRoleTemplate));
118    }
119    
120    @Override
121    public void doLock(PartySecurityRoleTemplateEdit edit, PartySecurityRoleTemplate partySecurityRoleTemplate) {
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 partySecurityRoleTemplateName = edit.getPartySecurityRoleTemplateName();
137        var duplicatePartySecurityRoleTemplate = securityControl.getPartySecurityRoleTemplateByName(partySecurityRoleTemplateName);
138
139        if(duplicatePartySecurityRoleTemplate != null && !partySecurityRoleTemplate.equals(duplicatePartySecurityRoleTemplate)) {
140            addExecutionError(ExecutionErrors.DuplicatePartySecurityRoleTemplateName.name(), partySecurityRoleTemplateName);
141        }
142    }
143    
144    @Override
145    public void doUpdate(PartySecurityRoleTemplate partySecurityRoleTemplate) {
146        var partyPK = getPartyPK();
147        var partySecurityRoleTemplateDetailValue = securityControl.getPartySecurityRoleTemplateDetailValueForUpdate(partySecurityRoleTemplate);
148        var partySecurityRoleTemplateDescription = securityControl.getPartySecurityRoleTemplateDescriptionForUpdate(partySecurityRoleTemplate, getPreferredLanguage());
149        var description = edit.getDescription();
150
151        partySecurityRoleTemplateDetailValue.setPartySecurityRoleTemplateName(edit.getPartySecurityRoleTemplateName());
152        partySecurityRoleTemplateDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
153        partySecurityRoleTemplateDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
154
155        securityControl.updatePartySecurityRoleTemplateFromValue(partySecurityRoleTemplateDetailValue, partyPK);
156
157        if(partySecurityRoleTemplateDescription == null && description != null) {
158            securityControl.createPartySecurityRoleTemplateDescription(partySecurityRoleTemplate, getPreferredLanguage(), description, partyPK);
159        } else if(partySecurityRoleTemplateDescription != null && description == null) {
160            securityControl.deletePartySecurityRoleTemplateDescription(partySecurityRoleTemplateDescription, partyPK);
161        } else if(partySecurityRoleTemplateDescription != null && description != null) {
162            var partySecurityRoleTemplateDescriptionValue = securityControl.getPartySecurityRoleTemplateDescriptionValue(partySecurityRoleTemplateDescription);
163
164            partySecurityRoleTemplateDescriptionValue.setDescription(description);
165            securityControl.updatePartySecurityRoleTemplateDescriptionFromValue(partySecurityRoleTemplateDescriptionValue, partyPK);
166        }
167    }
168    
169}