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.core.server.command;
018
019import com.echothree.control.user.core.common.edit.ApplicationEdit;
020import com.echothree.control.user.core.common.edit.CoreEditFactory;
021import com.echothree.control.user.core.common.form.EditApplicationForm;
022import com.echothree.control.user.core.common.result.CoreResultFactory;
023import com.echothree.control.user.core.common.result.EditApplicationResult;
024import com.echothree.control.user.core.common.spec.ApplicationSpec;
025import com.echothree.model.control.core.server.control.ApplicationControl;
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.core.server.entity.Application;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
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.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 EditApplicationCommand
045        extends BaseAbstractEditCommand<ApplicationSpec, ApplicationEdit, EditApplicationResult, Application, Application> {
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.Application.name(), SecurityRoles.Edit.name())
056                        ))
057                ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("ApplicationName", FieldType.ENTITY_NAME, true, null, null)
061                );
062        
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("ApplicationName", 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 EditApplicationCommand */
072    public EditApplicationCommand() {
073        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
074    }
075    
076    @Override
077    public EditApplicationResult getResult() {
078        return CoreResultFactory.getEditApplicationResult();
079    }
080
081    @Override
082    public ApplicationEdit getEdit() {
083        return CoreEditFactory.getApplicationEdit();
084    }
085
086    @Override
087    public Application getEntity(EditApplicationResult result) {
088        var applicationControl = Session.getModelController(ApplicationControl.class);
089        Application application;
090        var applicationName = spec.getApplicationName();
091
092        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
093            application = applicationControl.getApplicationByName(applicationName);
094        } else { // EditMode.UPDATE
095            application = applicationControl.getApplicationByNameForUpdate(applicationName);
096        }
097
098        if(application == null) {
099            addExecutionError(ExecutionErrors.UnknownApplicationName.name(), applicationName);
100        }
101
102        return application;
103    }
104
105    @Override
106    public Application getLockEntity(Application application) {
107        return application;
108    }
109
110    @Override
111    public void fillInResult(EditApplicationResult result, Application application) {
112        var applicationControl = Session.getModelController(ApplicationControl.class);
113
114        result.setApplication(applicationControl.getApplicationTransfer(getUserVisit(), application));
115    }
116
117    @Override
118    public void doLock(ApplicationEdit edit, Application application) {
119        var applicationControl = Session.getModelController(ApplicationControl.class);
120        var applicationDescription = applicationControl.getApplicationDescription(application, getPreferredLanguage());
121        var applicationDetail = application.getLastDetail();
122
123        edit.setApplicationName(applicationDetail.getApplicationName());
124        edit.setIsDefault(applicationDetail.getIsDefault().toString());
125        edit.setSortOrder(applicationDetail.getSortOrder().toString());
126
127        if(applicationDescription != null) {
128            edit.setDescription(applicationDescription.getDescription());
129        }
130    }
131
132    @Override
133    public void canUpdate(Application application) {
134        var applicationControl = Session.getModelController(ApplicationControl.class);
135        var applicationName = edit.getApplicationName();
136        var duplicateApplication = applicationControl.getApplicationByName(applicationName);
137
138        if(duplicateApplication != null && !application.equals(duplicateApplication)) {
139            addExecutionError(ExecutionErrors.DuplicateApplicationName.name(), applicationName);
140        }
141    }
142
143    @Override
144    public void doUpdate(Application application) {
145        var applicationControl = Session.getModelController(ApplicationControl.class);
146        var partyPK = getPartyPK();
147        var applicationDetailValue = applicationControl.getApplicationDetailValueForUpdate(application);
148        var applicationDescription = applicationControl.getApplicationDescriptionForUpdate(application, getPreferredLanguage());
149        var description = edit.getDescription();
150
151        applicationDetailValue.setApplicationName(edit.getApplicationName());
152        applicationDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
153        applicationDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
154
155        applicationControl.updateApplicationFromValue(applicationDetailValue, partyPK);
156
157        if(applicationDescription == null && description != null) {
158            applicationControl.createApplicationDescription(application, getPreferredLanguage(), description, partyPK);
159        } else {
160            if(applicationDescription != null && description == null) {
161                applicationControl.deleteApplicationDescription(applicationDescription, partyPK);
162            } else {
163                if(applicationDescription != null && description != null) {
164                    var applicationDescriptionValue = applicationControl.getApplicationDescriptionValue(applicationDescription);
165
166                    applicationDescriptionValue.setDescription(description);
167                    applicationControl.updateApplicationDescriptionFromValue(applicationDescriptionValue, partyPK);
168                }
169            }
170        }
171    }
172    
173}