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.printer.server.command;
018
019import com.echothree.control.user.printer.common.edit.PrinterEdit;
020import com.echothree.control.user.printer.common.edit.PrinterEditFactory;
021import com.echothree.control.user.printer.common.form.EditPrinterForm;
022import com.echothree.control.user.printer.common.result.EditPrinterResult;
023import com.echothree.control.user.printer.common.result.PrinterResultFactory;
024import com.echothree.control.user.printer.common.spec.PrinterSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.printer.server.control.PrinterControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.printer.server.entity.Printer;
030import com.echothree.model.data.printer.server.entity.PrinterGroup;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.EditMode;
036import com.echothree.util.server.control.BaseAbstractEditCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044import javax.enterprise.context.RequestScoped;
045
046@RequestScoped
047public class EditPrinterCommand
048        extends BaseAbstractEditCommand<PrinterSpec, PrinterEdit, EditPrinterResult, Printer, Printer> {
049
050    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
051    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
052    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
053
054    static {
055        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
056                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
057                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
058                        new SecurityRoleDefinition(SecurityRoleGroups.Printer.name(), SecurityRoles.Edit.name())
059                        )))
060                )));
061
062        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
063                new FieldDefinition("PrinterName", FieldType.ENTITY_NAME, true, null, null)
064                ));
065
066        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
067                new FieldDefinition("PrinterName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("Priority", FieldType.SIGNED_INTEGER, true, null, null),
069                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
070                ));
071    }
072
073    /** Creates a new instance of EditPrinterCommand */
074    public EditPrinterCommand() {
075        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077
078    @Override
079    public EditPrinterResult getResult() {
080        return PrinterResultFactory.getEditPrinterResult();
081    }
082
083    @Override
084    public PrinterEdit getEdit() {
085        return PrinterEditFactory.getPrinterEdit();
086    }
087
088    @Override
089    public Printer getEntity(EditPrinterResult result) {
090        var printerControl = Session.getModelController(PrinterControl.class);
091        Printer printer;
092        var printerName = spec.getPrinterName();
093
094        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
095            printer = printerControl.getPrinterByName(printerName);
096        } else { // EditMode.UPDATE
097            printer = printerControl.getPrinterByNameForUpdate(printerName);
098        }
099
100        if(printer != null) {
101            result.setPrinter(printerControl.getPrinterTransfer(getUserVisit(), printer));
102        } else {
103            addExecutionError(ExecutionErrors.UnknownPrinterName.name(), printerName);
104        }
105
106        return printer;
107    }
108
109    @Override
110    public Printer getLockEntity(Printer printer) {
111        return printer;
112    }
113
114    @Override
115    public void fillInResult(EditPrinterResult result, Printer printer) {
116        var printerControl = Session.getModelController(PrinterControl.class);
117
118        result.setPrinter(printerControl.getPrinterTransfer(getUserVisit(), printer));
119    }
120
121    @Override
122    public void doLock(PrinterEdit edit, Printer printer) {
123        var printerControl = Session.getModelController(PrinterControl.class);
124        var printerDescription = printerControl.getPrinterDescription(printer, getPreferredLanguage());
125        var printerDetail = printer.getLastDetail();
126
127        edit.setPrinterName(printerDetail.getPrinterName());
128        edit.setPrinterGroupName(printerDetail.getPrinterGroup().getLastDetail().getPrinterGroupName());
129        edit.setPriority(printerDetail.getPriority().toString());
130
131        if(printerDescription != null) {
132            edit.setDescription(printerDescription.getDescription());
133        }
134    }
135
136    PrinterGroup printerGroup;
137
138    @Override
139    public void canUpdate(Printer printer) {
140        var printerControl = Session.getModelController(PrinterControl.class);
141        var printerName = edit.getPrinterName();
142        var duplicatePrinter = printerControl.getPrinterByName(printerName);
143
144        if(duplicatePrinter != null && !printer.equals(duplicatePrinter)) {
145            addExecutionError(ExecutionErrors.DuplicatePrinterName.name(), printerName);
146        } else {
147            var printerGroupName = edit.getPrinterGroupName();
148
149            printerGroup = printerControl.getPrinterGroupByName(printerGroupName);
150
151            if(printerGroup == null) {
152                addExecutionError(ExecutionErrors.DuplicatePrinterGroupName.name(), printerGroupName);
153            }
154        }
155    }
156
157    @Override
158    public void doUpdate(Printer printer) {
159        var printerControl = Session.getModelController(PrinterControl.class);
160        var partyPK = getPartyPK();
161        var printerDetailValue = printerControl.getPrinterDetailValueForUpdate(printer);
162        var printerDescription = printerControl.getPrinterDescriptionForUpdate(printer, getPreferredLanguage());
163        var description = edit.getDescription();
164
165        printerDetailValue.setPrinterName(edit.getPrinterName());
166        printerDetailValue.setPrinterGroupPK(printerGroup.getPrimaryKey());
167        printerDetailValue.setPriority(Integer.valueOf(edit.getPriority()));
168
169        printerControl.updatePrinterFromValue(printerDetailValue, partyPK);
170
171        if(printerDescription == null && description != null) {
172            printerControl.createPrinterDescription(printer, getPreferredLanguage(), description, partyPK);
173        } else if(printerDescription != null && description == null) {
174            printerControl.deletePrinterDescription(printerDescription, partyPK);
175        } else if(printerDescription != null && description != null) {
176            var printerDescriptionValue = printerControl.getPrinterDescriptionValue(printerDescription);
177
178            printerDescriptionValue.setDescription(description);
179            printerControl.updatePrinterDescriptionFromValue(printerDescriptionValue, partyPK);
180        }
181    }
182
183}