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