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.printer.server.command;
018
019import com.echothree.control.user.printer.common.edit.PrinterEditFactory;
020import com.echothree.control.user.printer.common.edit.PrinterGroupEdit;
021import com.echothree.control.user.printer.common.form.EditPrinterGroupForm;
022import com.echothree.control.user.printer.common.result.EditPrinterGroupResult;
023import com.echothree.control.user.printer.common.result.PrinterResultFactory;
024import com.echothree.control.user.printer.common.spec.PrinterGroupSpec;
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.control.uom.common.UomConstants;
030import com.echothree.model.control.uom.server.logic.UnitOfMeasureTypeLogic;
031import com.echothree.model.data.printer.server.entity.PrinterGroup;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.common.command.EditMode;
037import com.echothree.util.server.control.BaseAbstractEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import com.echothree.util.server.persistence.Session;
042import java.util.List;
043import javax.enterprise.context.Dependent;
044
045@Dependent
046public class EditPrinterGroupCommand
047        extends BaseAbstractEditCommand<PrinterGroupSpec, PrinterGroupEdit, EditPrinterGroupResult, PrinterGroup, PrinterGroup> {
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(List.of(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
057                        new SecurityRoleDefinition(SecurityRoleGroups.PrinterGroup.name(), SecurityRoles.Edit.name())
058                        ))
059                ));
060
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("PrinterGroupName", FieldType.ENTITY_NAME, true, null, null)
063                );
064
065        EDIT_FIELD_DEFINITIONS = List.of(
066                new FieldDefinition("PrinterGroupName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("KeepPrintedJobsTime", FieldType.UNSIGNED_LONG, false, null, null),
068                new FieldDefinition("KeepPrintedJobsTimeUnitOfMeasureTypeName", FieldType.ENTITY_NAME, false, null, null),
069                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
070                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
071                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
072                );
073    }
074
075    /** Creates a new instance of EditPrinterGroupCommand */
076    public EditPrinterGroupCommand() {
077        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079
080    @Override
081    public EditPrinterGroupResult getResult() {
082        return PrinterResultFactory.getEditPrinterGroupResult();
083    }
084
085    @Override
086    public PrinterGroupEdit getEdit() {
087        return PrinterEditFactory.getPrinterGroupEdit();
088    }
089
090    @Override
091    public PrinterGroup getEntity(EditPrinterGroupResult result) {
092        var printerControl = Session.getModelController(PrinterControl.class);
093        PrinterGroup printerGroup;
094        var printerGroupName = spec.getPrinterGroupName();
095
096        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
097            printerGroup = printerControl.getPrinterGroupByName(printerGroupName);
098        } else { // EditMode.UPDATE
099            printerGroup = printerControl.getPrinterGroupByNameForUpdate(printerGroupName);
100        }
101
102        if(printerGroup != null) {
103            result.setPrinterGroup(printerControl.getPrinterGroupTransfer(getUserVisit(), printerGroup));
104        } else {
105            addExecutionError(ExecutionErrors.UnknownPrinterGroupName.name(), printerGroupName);
106        }
107
108        return printerGroup;
109    }
110
111    @Override
112    public PrinterGroup getLockEntity(PrinterGroup printerGroup) {
113        return printerGroup;
114    }
115
116    @Override
117    public void fillInResult(EditPrinterGroupResult result, PrinterGroup printerGroup) {
118        var printerControl = Session.getModelController(PrinterControl.class);
119
120        result.setPrinterGroup(printerControl.getPrinterGroupTransfer(getUserVisit(), printerGroup));
121    }
122
123    @Override
124    public void doLock(PrinterGroupEdit edit, PrinterGroup printerGroup) {
125        var printerControl = Session.getModelController(PrinterControl.class);
126        var unitOfMeasureTypeLogic = UnitOfMeasureTypeLogic.getInstance();
127        var printerGroupDescription = printerControl.getPrinterGroupDescription(printerGroup, getPreferredLanguage());
128        var printerGroupDetail = printerGroup.getLastDetail();
129        UnitOfMeasureTypeLogic.StringUnitOfMeasure stringUnitOfMeasure;
130
131        edit.setPrinterGroupName(printerGroupDetail.getPrinterGroupName());
132        stringUnitOfMeasure = unitOfMeasureTypeLogic.unitOfMeasureToString(this, UomConstants.UnitOfMeasureKindUseType_TIME, printerGroupDetail.getKeepPrintedJobsTime());
133        edit.setKeepPrintedJobsTimeUnitOfMeasureTypeName(stringUnitOfMeasure.getUnitOfMeasureTypeName());
134        edit.setKeepPrintedJobsTime(stringUnitOfMeasure.getValue());
135        edit.setIsDefault(printerGroupDetail.getIsDefault().toString());
136        edit.setSortOrder(printerGroupDetail.getSortOrder().toString());
137
138        if(printerGroupDescription != null) {
139            edit.setDescription(printerGroupDescription.getDescription());
140        }
141    }
142
143    Long keepPrintedJobsTime;
144
145    @Override
146    public void canUpdate(PrinterGroup printerGroup) {
147        var printerControl = Session.getModelController(PrinterControl.class);
148        var printerGroupName = edit.getPrinterGroupName();
149        var duplicatePrinterGroup = printerControl.getPrinterGroupByName(printerGroupName);
150
151        if(duplicatePrinterGroup != null && !printerGroup.equals(duplicatePrinterGroup)) {
152            addExecutionError(ExecutionErrors.DuplicatePrinterGroupName.name(), printerGroupName);
153        } else {
154            var unitOfMeasureTypeLogic = UnitOfMeasureTypeLogic.getInstance();
155
156            keepPrintedJobsTime = unitOfMeasureTypeLogic.checkUnitOfMeasure(this, UomConstants.UnitOfMeasureKindUseType_TIME,
157                    edit.getKeepPrintedJobsTime(), edit.getKeepPrintedJobsTimeUnitOfMeasureTypeName(),
158                    null, ExecutionErrors.MissingRequiredKeepPrintedJobsTime.name(), null, ExecutionErrors.MissingRequiredKeepPrintedJobsTimeUnitOfMeasureTypeName.name(),
159                    null, ExecutionErrors.UnknownKeepPrintedJobsTimeUnitOfMeasureTypeName.name());
160        }
161    }
162
163    @Override
164    public void doUpdate(PrinterGroup printerGroup) {
165        var printerControl = Session.getModelController(PrinterControl.class);
166        var partyPK = getPartyPK();
167        var printerGroupDetailValue = printerControl.getPrinterGroupDetailValueForUpdate(printerGroup);
168        var printerGroupDescription = printerControl.getPrinterGroupDescriptionForUpdate(printerGroup, getPreferredLanguage());
169        var description = edit.getDescription();
170
171        printerGroupDetailValue.setPrinterGroupName(edit.getPrinterGroupName());
172        printerGroupDetailValue.setKeepPrintedJobsTime(keepPrintedJobsTime);
173        printerGroupDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
174        printerGroupDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
175
176        printerControl.updatePrinterGroupFromValue(printerGroupDetailValue, partyPK);
177
178        if(printerGroupDescription == null && description != null) {
179            printerControl.createPrinterGroupDescription(printerGroup, getPreferredLanguage(), description, partyPK);
180        } else if(printerGroupDescription != null && description == null) {
181            printerControl.deletePrinterGroupDescription(printerGroupDescription, partyPK);
182        } else if(printerGroupDescription != null && description != null) {
183            var printerGroupDescriptionValue = printerControl.getPrinterGroupDescriptionValue(printerGroupDescription);
184
185            printerGroupDescriptionValue.setDescription(description);
186            printerControl.updatePrinterGroupDescriptionFromValue(printerGroupDescriptionValue, partyPK);
187        }
188    }
189
190}